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>
This commit is contained in:
Heiko Thiery
2020-04-21 09:26:02 +02:00
committed by Jakub Jelen
parent 99e0ad75a6
commit e76332bbd6

View File

@@ -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,