mirror of
https://github.com/libssh2/libssh2.git
synced 2025-05-01 13:44:44 +03:00
e590450dcc
- add missing `.fi` tags. - fix misplaced `.nf` tags. - add `.nf`/`.fi` tags `SYNOPSIS` where missing. - fix missing/wrong function name from `SH NAME`. - fix wrong function name in `TH`. - keep return values in a separate line. - indent. - fold long lines. - deleted `libssh2_channel_direct_streamlocal()`, there is no such function. - add missing types. - add missing headers. Closes #949
22 lines
659 B
Groff
22 lines
659 B
Groff
.TH libssh2_poll_channel_read 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual"
|
|
.SH NAME
|
|
libssh2_poll_channel_read - check if data is available
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <libssh2.h>
|
|
|
|
int
|
|
libssh2_poll_channel_read(LIBSSH2_CHANNEL *channel, int extended);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
This function is deprecated. Do note use.
|
|
|
|
\fIlibssh2_poll_channel_read(3)\fP checks to see if data is available in the
|
|
\fIchannel\fP's read buffer. No attempt is made with this method to see if
|
|
packets are available to be processed. For full polling support, use
|
|
\fIlibssh2_poll(3)\fP.
|
|
.SH RETURN VALUE
|
|
Returns 1 when data is available and 0 otherwise.
|
|
.SH SEE ALSO
|
|
.BR libssh2_poll(3)
|