mirror of
https://github.com/libssh2/libssh2.git
synced 2025-11-02 10:53:16 +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
36 lines
732 B
Markdown
36 lines
732 B
Markdown
---
|
|
c: Copyright (C) The libssh2 project and its contributors.
|
|
SPDX-License-Identifier: BSD-3-Clause
|
|
Title: libssh2_poll_channel_read
|
|
Section: 3
|
|
Source: libssh2
|
|
See-also:
|
|
- libssh2_poll(3)
|
|
---
|
|
|
|
# NAME
|
|
|
|
libssh2_poll_channel_read - check if data is available
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <libssh2.h>
|
|
|
|
int
|
|
libssh2_poll_channel_read(LIBSSH2_CHANNEL *channel, int extended);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
This function is deprecated. Do note use.
|
|
|
|
*libssh2_poll_channel_read(3)* checks to see if data is available in the
|
|
*channel*'s read buffer. No attempt is made with this method to see if
|
|
packets are available to be processed. For full polling support, use
|
|
*libssh2_poll(3)*.
|
|
|
|
# RETURN VALUE
|
|
|
|
Returns 1 when data is available and 0 otherwise.
|