mirror of https://github.com/libssh2/libssh2.git synced 2026-10-24 03:48:58 +03:00

Files

Viktor Szakats 99803822cb tidy-up: miscellaneous

- fix typos in comments and documentation.
- fix references to non-existing functions in comments.
- libssh2_session_free: fix see-also reference on man page.
- libssh2_scp_recv2: fix typo in prototype on man page.
- man2help: use increment operator.
- badwords: extend with new words and an exclusion.
- userauth: unfold string.
- clang-format and manual formatting.

Closes #1988

2026-06-05 18:12:37 +02:00

1.1 KiB

Raw Blame History

c, SPDX-License-Identifier, Title, Section, Source, See-also

SPDX-License-Identifier

Title

Section

Source

See-also

BSD-3-Clause

libssh2_poll

libssh2

libssh2_poll_channel_read(3)

NAME

libssh2_poll - poll for activity on a socket, channel or listener

SYNOPSIS

#include <libssh2.h>

int libssh2_poll(LIBSSH2_POLLFD *fds, unsigned int nfds, long timeout);

DESCRIPTION

This function is deprecated. Do not 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.

AVAILABILITY

Marked as deprecated since 1.2.0

RETURN VALUE

Number of fds with interesting events.

1.1 KiB Raw Blame History