libssh2/share/man/man3/libssh2_session_set_blocking.3

   1 .\" $Id: libssh2_session_set_blocking.3,v 1.1 2007/06/14 17:23:13 jehousley Exp $
   2 .\"
   3 .TH libssh2_session_set_blocking 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
   4 .SH NAME
   5 libssh2_session_set_blocking - set or clear blocking mode on session
   6 .SH SYNOPSIS
   7 #include <libssh2.h>
   8
   9 void
  10 libssh2_session_set_blocking(LIBSSH2_SESSION *session, int blocking);
  11
  12 .SH DESCRIPTION
  13 \fIsession\fP - session instance as returned by
  14 .BR libssh2_session_init(3)
  15
  16 \fIblocking\fP - Set to a non-zero value to make the channel block, or zero to
  17 make it non-blocking.
  18
  19 Set or clear blocking mode on the selected on the sessoin.  This will
  20 instantly affect any channels associtated with this session. If a read is
  21 performed on a session with no data currently available, a blocking
  22 session will wait for data to arrive and return what it receives.
  23 A non-blocking session will return immediately with an empty buffer.
  24 If a write is performed on a session with
  25 no room for more data, a blocking session will wait for room.  A non-blocking
  26 session will return immediately without writing anything.
  27
  28 .SH RETURN VALUE
  29 None
  30
  31 .SH SEE ALSO
  32 .BR libssh2_session_init(3)