Current File : //usr/share/man/man3ssh2/libssh2_session_set_blocking.3ssh2

'\" te
.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_ex(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 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.

.SH RETURN VALUE
None


.\" Oracle has added the ARC stability level to this manual page
.SH ATTRIBUTES
See
.BR attributes (5)
for descriptions of the following attributes:
.sp
.TS
box;
cbp-1 | cbp-1
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE 
=
Availability	library/libssh2
=
Stability	Uncommitted
.TE 
.PP
.SH SEE ALSO
.BR libssh2_session_init_ex(3)


.SH NOTES

.\" Oracle has added source availability information to this manual page
This software was built from source available at https://java.net/projects/solaris-userland.  The original community source was downloaded from  http://www.libssh2.org/download/libssh2-1.4.2.tar.gz

Further information about this software can be found on the open source community website at http://www.libssh2.org/.