Mercurial > repos > rliterman > csp2
diff 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 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/share/man/man3/libssh2_poll.3 Tue Mar 18 16:23:26 2025 -0400 @@ -0,0 +1,21 @@ +.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 +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)