annotate CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/share/man/man3/libssh2_poll.3 @ 68:5028fdace37b
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
| author |
jpayne |
| date |
Tue, 18 Mar 2025 16:23:26 -0400 |
| parents |
|
| children |
|
| rev |
line source |
|
jpayne@68
|
1 .TH libssh2_poll 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual"
|
|
jpayne@68
|
2 .SH NAME
|
|
jpayne@68
|
3 libssh2_poll - poll for activity on a socket, channel or listener
|
|
jpayne@68
|
4 .SH SYNOPSIS
|
|
jpayne@68
|
5 #include <libssh2.h>
|
|
jpayne@68
|
6
|
|
jpayne@68
|
7 int libssh2_poll(LIBSSH2_POLLFD *fds, unsigned int nfds, long timeout);
|
|
jpayne@68
|
8 .SH DESCRIPTION
|
|
jpayne@68
|
9 This function is deprecated. Do note use. We encourage users to instead use
|
|
jpayne@68
|
10 the \fIpoll(3)\fP or \fIselect(3)\fP functions to check for socket activity or
|
|
jpayne@68
|
11 when specific sockets are ready to get received from or send to.
|
|
jpayne@68
|
12
|
|
jpayne@68
|
13 Poll for activity on a socket, channel, listener, or any combination of these
|
|
jpayne@68
|
14 three types. The calling semantics for this function generally match
|
|
jpayne@68
|
15 \fIpoll(2)\fP however the structure of fds is somewhat more complex in order
|
|
jpayne@68
|
16 to accommodate the disparate datatypes, POLLFD constants have been namespaced
|
|
jpayne@68
|
17 to avoid platform discrepancies, and revents has additional values defined.
|
|
jpayne@68
|
18 .SH "RETURN VALUE"
|
|
jpayne@68
|
19 Number of fds with interesting events.
|
|
jpayne@68
|
20 .SH SEE ALSO
|
|
jpayne@68
|
21 .BR libssh2_poll_channel_read(3)
|
