www.libssh2.org | Daily snapshots | Mailing list archive | Docs | Examples | github
libssh2_poll

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 additional values defined.

RETURN VALUE

Number of fds with interesting events.

SEE ALSO

libssh2_poll_channel_read

This HTML page was made with roffit.