libssh2/share/man/man3/libssh2_poll.3

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