mirror of
https://github.com/libssh2/libssh2.git
synced 2025-07-02 22:02:25 +03:00
592e2b37fa
- simplify `.TH` headers. - delete empty lines before sections. - update template with an `AVAILABILITY` section. Left libssh2 version number in the `.TH` header for entries without an `AVAILABILITY` section, or where there was a different version number there.
25 lines
967 B
Groff
25 lines
967 B
Groff
.TH libssh2_poll 3 "14 Dec 2006" "libssh2 0.15" "libssh2"
|
|
.SH NAME
|
|
libssh2_poll - poll for activity on a socket, channel or listener
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <libssh2.h>
|
|
|
|
int
|
|
libssh2_poll(LIBSSH2_POLLFD *fds, unsigned int nfds, long timeout);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
This function is deprecated. Do note use. We encourage users to instead use
|
|
the \fIpoll(3)\fP or \fIselect(3)\fP 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
|
|
\fIpoll(2)\fP 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.
|
|
.SH "RETURN VALUE"
|
|
Number of fds with interesting events.
|
|
.SH SEE ALSO
|
|
.BR libssh2_poll_channel_read(3)
|