mirror of
https://github.com/libssh2/libssh2.git
synced 2025-10-24 14:53:03 +03:00
b889b39945
To render in Git webviews as-is, to make it easier to edit, verify,
and to sync up with curl.
- add options to not build the `.3` man pages:
- autotools: `--disable-docs`
- cmake: `LIBSSH2_BUILD_DOCS=OFF`
- building `.3` man pages requires Perl after this patch.
- drop `mansyntax` and the shell / `grep` / GNU `man` tool requirements with it.
- scripts and most logic were copied from curl.
- add `cd2nroff` from curl, with edits to relax curl-specific checks.
- used `nroff2cd` (from curl) to convert from `.3` to `.md`. Then
manually fixed copyrights, inline function references and a couple
of other things.
Credits-to: Daniel Stenberg
Ref: eefcc1bda4
Ref: https://github.com/curl/curl/pull/12730
Ref: https://github.com/libssh2/www/issues/25#issuecomment-3289431671
Closes #1660
39 lines
1.0 KiB
Markdown
39 lines
1.0 KiB
Markdown
---
|
|
c: Copyright (C) The libssh2 project and its contributors.
|
|
SPDX-License-Identifier: BSD-3-Clause
|
|
Title: libssh2_poll
|
|
Section: 3
|
|
Source: libssh2
|
|
See-also:
|
|
- libssh2_poll_channel_read(3)
|
|
---
|
|
|
|
# NAME
|
|
|
|
libssh2_poll - poll for activity on a socket, channel or listener
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <libssh2.h>
|
|
|
|
int
|
|
libssh2_poll(LIBSSH2_POLLFD *fds, unsigned int nfds, long timeout);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
This function is deprecated. Do note use. We encourage users to instead use
|
|
the *poll(3)* or *select(3)* 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
|
|
*poll(2)* 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.
|
|
|
|
# RETURN VALUE
|
|
|
|
Number of fds with interesting events.
|