diff options
| author | Heiko Thiery <heiko.thiery@gmail.com> | 2020-04-21 09:26:02 +0200 |
|---|---|---|
| committer | Jakub Jelen <jjelen@redhat.com> | 2020-04-24 16:00:29 +0200 |
| commit | e76332bbd6177591f798d4b6b9f294fa46c8e066 (patch) | |
| tree | 1a8a800c5601a685bd49cd9ba805f1d6e0b1e145 | |
| parent | 99e0ad75a6d1d5b6dbaaa57204af1f6d71a5dc72 (diff) | |
| download | libssh-e76332bbd6177591f798d4b6b9f294fa46c8e066.tar.gz libssh-e76332bbd6177591f798d4b6b9f294fa46c8e066.tar.xz libssh-e76332bbd6177591f798d4b6b9f294fa46c8e066.zip | |
session: add missing return value documentation
Add SSH_AGAIN as return value to ssh_handle_packets documentation.
Signed-off-by: Heiko Thiery <heiko.thiery@gmail.com>
Reviewed-by: Jakub Jelen <jjelen@redhat.com>
| -rw-r--r-- | src/session.c | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/src/session.c b/src/session.c index 3b3830f7..3199096a 100644 --- a/src/session.c +++ b/src/session.c @@ -689,7 +689,8 @@ int ssh_handle_packets(ssh_session session, int timeout) { * @param[in] fct Termination function to be used to determine if it is * possible to stop polling. * @param[in] user User parameter to be passed to fct termination function. - * @return SSH_OK on success, SSH_ERROR otherwise. + * @returns SSH_OK on success, SSH_AGAIN if timeout occurred, + * SSH_ERROR otherwise. */ int ssh_handle_packets_termination(ssh_session session, long timeout, |