libssh2_session_set_timeout.3 656 B

1234567891011121314151617181920
  1. .TH libssh2_session_set_timeout 3 "4 May 2011" "libssh2 1.2.9" "libssh2 manual"
  2. .SH NAME
  3. libssh2_session_set_timeout - set timeout for blocking functions
  4. .SH SYNOPSIS
  5. #include <libssh2.h>
  6. .nf
  7. void libssh2_session_set_timeout(LIBSSH2_SESSION *session, long timeout);
  8. .SH DESCRIPTION
  9. Set the \fBtimeout\fP in milliseconds for how long a blocking the libssh2
  10. function calls may wait until they consider the situation an error and return
  11. LIBSSH2_ERROR_TIMEOUT.
  12. By default or if you set the timeout to zero, libssh2 has no timeout for
  13. blocking functions.
  14. .SH RETURN VALUE
  15. Nothing
  16. .SH AVAILABILITY
  17. Added in 1.2.9
  18. .SH SEE ALSO
  19. .BR libssh2_session_get_timeout(3)