2007-06-13 14:51:10 +02:00
|
|
|
.\" $Id: libssh2_poll.3,v 1.3 2007/06/13 12:51:11 jehousley Exp $
|
2007-02-23 11:20:56 +01:00
|
|
|
.\"
|
|
|
|
|
.TH libssh2_poll 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual"
|
|
|
|
|
.SH NAME
|
|
|
|
|
libssh2_poll - poll for activity on a socket, channel or listener
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
#include <libssh2.h>
|
|
|
|
|
|
|
|
|
|
int libssh2_poll(LIBSSH2_POLLFD *fds, unsigned int nfds, long timeout);
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
Poll for activity on a socket, channel, listener, or any combination of these
|
|
|
|
|
three types. The calling semantics for this function generally match
|
|
|
|
|
\fIpoll(2)\fP however the structure of fds is somewhat more complex in order
|
2007-04-12 23:30:03 +02:00
|
|
|
to accommodate the disparate datatypes, POLLFD constants have been namespaced
|
|
|
|
|
to avoid platform discrepancies, and revents has additional values defined.
|
2007-02-23 11:20:56 +01:00
|
|
|
.SH "RETURN VALUE"
|
2007-04-12 23:30:03 +02:00
|
|
|
Number of fds with interesting events.
|
2007-06-13 14:51:10 +02:00
|
|
|
.SH SEE ALSO
|
2007-02-23 11:20:56 +01:00
|
|
|
.BR libssh2_poll_channel_read(3)
|
