33 lines
1.1 KiB
Groff
33 lines
1.1 KiB
Groff
.\" $Id: libssh2_session_set_blocking.3,v 1.1 2007/06/14 17:23:13 jehousley Exp $
|
|
.\"
|
|
.TH libssh2_session_set_blocking 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
|
|
.SH NAME
|
|
libssh2_session_set_blocking - set or clear blocking mode on session
|
|
.SH SYNOPSIS
|
|
#include <libssh2.h>
|
|
|
|
void
|
|
libssh2_session_set_blocking(LIBSSH2_SESSION *session, int blocking);
|
|
|
|
.SH DESCRIPTION
|
|
\fIsession\fP - session instance as returned by
|
|
.BR libssh2_session_init(3)
|
|
|
|
\fIblocking\fP - 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 sessoin. This will
|
|
instantly affect any channels associtated 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.
|
|
|
|
.SH RETURN VALUE
|
|
None
|
|
|
|
.SH SEE ALSO
|
|
.BR libssh2_session_init(3)
|