Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

libssh2_session_set_blocking (3ssh2)

Name

libssh2_session_set_blocking - set or clear blocking mode on session

Synopsis

#include <libssh2.h>

void  libssh2_session_set_blocking(LIBSSH2_SESSION *session, int block-
ing);

Description

libssh2 manual                             libssh2_session_set_blocking(3ssh2)



NAME
       libssh2_session_set_blocking - set or clear blocking mode on session

SYNOPSIS
       #include <libssh2.h>

       void  libssh2_session_set_blocking(LIBSSH2_SESSION *session, int block-
       ing);


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  block-
       ing  session  will  wait  for room.  A non-blocking session will return
       immediately without writing anything.


RETURN VALUE
       None



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/libssh2  |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       libssh2_session_init_ex(3)



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 0.15                      1 Jun 2007
                                           libssh2_session_set_blocking(3ssh2)