libssh2_session_block_directions.3 (1180B)
1.TH libssh2_session_block_directions 3 "1 Oct 2008" "libssh2" "libssh2" 2.SH NAME 3libssh2_session_block_directions - get directions to wait for 4.SH SYNOPSIS 5.nf 6#include <libssh2.h> 7 8int 9libssh2_session_block_directions(LIBSSH2_SESSION *session); 10.fi 11.SH DESCRIPTION 12\fIsession\fP - Session instance as returned by \fBlibssh2_session_init_ex(3)\fP 13 14When any of libssh2 functions return \fBLIBSSH2_ERROR_EAGAIN\fP an application 15should wait for the socket to have data available for reading or 16writing. Depending on the return value of 17\fIlibssh2_session_block_directions(3)\fP an application should wait for read, 18write or both. 19.SH RETURN VALUE 20Returns the set of directions as a binary mask. Can be a combination of: 21 22LIBSSH2_SESSION_BLOCK_INBOUND: Inbound direction blocked. 23 24LIBSSH2_SESSION_BLOCK_OUTBOUND: Outbound direction blocked. 25 26Application should wait for data to be available for socket prior to calling a 27libssh2 function again. If \fBLIBSSH2_SESSION_BLOCK_INBOUND\fP is set select 28should contain the session socket in readfds set. Correspondingly in case of 29\fBLIBSSH2_SESSION_BLOCK_OUTBOUND\fP writefds set should contain the socket. 30.SH AVAILABILITY 31Added in 1.0