mirror of
https://github.com/libssh2/libssh2.git
synced 2025-10-31 23:30:25 +03:00
592e2b37fa
- simplify `.TH` headers. - delete empty lines before sections. - update template with an `AVAILABILITY` section. Left libssh2 version number in the `.TH` header for entries without an `AVAILABILITY` section, or where there was a different version number there.
22 lines
652 B
Groff
22 lines
652 B
Groff
.TH libssh2_poll_channel_read 3 "14 Dec 2006" "libssh2 0.15" "libssh2"
|
|
.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)
|