jpayne@68: .TH libssh2_poll 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual"
jpayne@68: .SH NAME
jpayne@68: libssh2_poll - poll for activity on a socket, channel or listener
jpayne@68: .SH SYNOPSIS
jpayne@68: #include <libssh2.h>
jpayne@68: 
jpayne@68: int libssh2_poll(LIBSSH2_POLLFD *fds, unsigned int nfds, long timeout);
jpayne@68: .SH DESCRIPTION
jpayne@68: This function is deprecated. Do note use. We encourage users to instead use
jpayne@68: the \fIpoll(3)\fP or \fIselect(3)\fP functions to check for socket activity or
jpayne@68: when specific sockets are ready to get received from or send to.
jpayne@68: 
jpayne@68: Poll for activity on a socket, channel, listener, or any combination of these
jpayne@68: three types. The calling semantics for this function generally match
jpayne@68: \fIpoll(2)\fP however the structure of fds is somewhat more complex in order
jpayne@68: to accommodate the disparate datatypes, POLLFD constants have been namespaced
jpayne@68: to avoid platform discrepancies, and revents has additional values defined.
jpayne@68: .SH "RETURN VALUE"
jpayne@68: Number of fds with interesting events.
jpayne@68: .SH SEE ALSO
jpayne@68: .BR libssh2_poll_channel_read(3)