Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

libssh2_poll_channel_read (3ssh2)

Name

libssh2_poll_channel_read - check if data is available

Synopsis

#include <libssh2.h>

int libssh2_poll_channel_read(LIBSSH2_CHANNEL *channel, int extended);

Description

libssh2 manual                                libssh2_poll_channel_read(3ssh2)



NAME
       libssh2_poll_channel_read - check if data is available

SYNOPSIS
       #include <libssh2.h>

       int libssh2_poll_channel_read(LIBSSH2_CHANNEL *channel, int extended);

DESCRIPTION
       This function is deprecated. Do note use.

       libssh2_poll_channel_read(3)  checks to see if data is available in the
       channel's read buffer. No attempt is made with this method  to  see  if
       packets  are  available  to be processed. For full polling support, use
       libssh2_poll(3).

RETURN VALUE
       Returns 1 when data is available and 0 otherwise.


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


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

SEE ALSO
       libssh2_poll(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                      14 Dec 2006
                                              libssh2_poll_channel_read(3ssh2)