Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

libssh2_poll (3ssh2)

Name

libssh2_poll - poll for activity on a socket, channel or listener

Synopsis

#include <libssh2.h>

int libssh2_poll(LIBSSH2_POLLFD *fds, unsigned int nfds, long timeout);

Description

libssh2_poll(3ssh2)             libssh2 manual             libssh2_poll(3ssh2)



NAME
       libssh2_poll - poll for activity on a socket, channel or listener

SYNOPSIS
       #include <libssh2.h>

       int libssh2_poll(LIBSSH2_POLLFD *fds, unsigned int nfds, long timeout);

DESCRIPTION
       This function is deprecated. Do note use. We encourage users to instead
       use the poll(3) or select(3) functions to check for socket activity  or
       when specific sockets are ready to get received from or send to.

       Poll for activity on a socket, channel, listener, or any combination of
       these three types. The calling semantics for  this  function  generally
       match  poll(2) however the structure of fds is somewhat more complex in
       order to accommodate the disparate  datatypes,  POLLFD  constants  have
       been  namespaced to avoid platform discrepancies, and revents has addi-
       tional values defined.

RETURN VALUE
       Number of fds with interesting events.


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


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

SEE ALSO
       libssh2_poll_channel_read(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(3ssh2)