libssh2_session_block_directions - get directions to wait for
#include <libssh2.h> int libssh2_session_block_directions(LIBSSH2_SESSION *session);
libssh2 manual libssh2_session_block_directions(3ssh2)
NAME
libssh2_session_block_directions - get directions to wait for
SYNOPSIS
#include <libssh2.h>
int libssh2_session_block_directions(LIBSSH2_SESSION *session);
DESCRIPTION
session - Session instance as returned by libssh2_session_init_ex(3)
When any of libssh2 functions return LIBSSH2_ERROR_EAGAIN an applica-
tion should wait for the socket to have data available for reading or
writing. Depending on the return value of libssh2_session_block_direc-
tions(3) an application should wait for read, write or both.
RETURN VALUE
Returns the set of directions as a binary mask. Can be a combination
of:
LIBSSH2_SESSION_BLOCK_INBOUND: Inbound direction blocked.
LIBSSH2_SESSION_BLOCK_OUTBOUND: Outbound direction blocked.
Application should wait for data to be available for socket prior to
calling a libssh2 function again. If LIBSSH2_SESSION_BLOCK_INBOUND is
set select should contain the session socket in readfds set. Corre-
spondingly in case of LIBSSH2_SESSION_BLOCK_OUTBOUND writefds set
should contain the socket.
AVAILABILITY
Added in 1.0
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+------------------+
|Availability | library/libssh2 |
+---------------+------------------+
|Stability | Uncommitted |
+---------------+------------------+
NOTES
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from https://www.libssh2.org/download/lib-
ssh2-1.10.0.tar.gz.
Further information about this software can be found on the open source
community website at https://www.libssh2.org/.
libssh2 1.0 1 Oct 2008
libssh2_session_block_directions(3ssh2)