libssh2_session_set_blocking man page

libssh2_session_set_blocking — set or clear blocking mode on session

Synopsis

#include <libssh2.h>

void libssh2_session_set_blocking(LIBSSH2_SESSION *session, int blocking);

Description

session - session instance as returned by libssh2_session_init_ex(3)

blocking - Set to a non-zero value to make the channel block, or zero to make it non-blocking.

Set or clear blocking mode on the selected on the session. This will instantly affect any channels associated with this session. If a read is performed on a session with no data currently available, a blocking session will wait for data to arrive and return what it receives. A non-blocking session will return immediately with an empty buffer. If a write is performed on a session with no room for more data, a blocking session will wait for room. A non-blocking session will return immediately without writing anything.

Return Value

None

See Also

libssh2_session_init_ex(3)

Referenced By

libssh2_channel_set_blocking(3), libssh2_session_get_blocking(3).

1 Jun 2007 libssh2 0.15 libssh2 manual