libssh2

1
.\" Copyright (C) The libssh2 project and its contributors.
2
.\" SPDX-License-Identifier: BSD-3-Clause
3
.TH libssh2_poll 3 "14 Dec 2006" "libssh2 0.15" "libssh2"
4
.SH NAME
5
libssh2_poll - poll for activity on a socket, channel or listener
6
.SH SYNOPSIS
7
.nf
8
#include <libssh2.h>
9

10
int
11
libssh2_poll(LIBSSH2_POLLFD *fds, unsigned int nfds, long timeout);
12
.fi
13
.SH DESCRIPTION
14
This function is deprecated. Do note use. We encourage users to instead use
15
the \fIpoll(3)\fP or \fIselect(3)\fP functions to check for socket activity or
16
when specific sockets are ready to get received from or send to.
17

18
Poll for activity on a socket, channel, listener, or any combination of these
19
three types. The calling semantics for this function generally match
20
\fIpoll(2)\fP however the structure of fds is somewhat more complex in order
21
to accommodate the disparate datatypes, POLLFD constants have been namespaced
22
to avoid platform discrepancies, and revents has additional values defined.
23
.SH "RETURN VALUE"
24
Number of fds with interesting events.
25
.SH SEE ALSO
26
.BR libssh2_poll_channel_read(3)
27