libssh2

1
.\" Copyright (C) The libssh2 project and its contributors.
2
.\" SPDX-License-Identifier: BSD-3-Clause
3
.TH libssh2_poll_channel_read 3 "14 Dec 2006" "libssh2 0.15" "libssh2"
4
.SH NAME
5
libssh2_poll_channel_read - check if data is available
6
.SH SYNOPSIS
7
.nf
8
#include <libssh2.h>
9

10
int
11
libssh2_poll_channel_read(LIBSSH2_CHANNEL *channel, int extended);
12
.fi
13
.SH DESCRIPTION
14
This function is deprecated. Do note use.
15

16
\fIlibssh2_poll_channel_read(3)\fP checks to see if data is available in the
17
\fIchannel\fP's read buffer. No attempt is made with this method to see if
18
packets are available to be processed. For full polling support, use
19
\fIlibssh2_poll(3)\fP.
20
.SH RETURN VALUE
21
Returns 1 when data is available and 0 otherwise.
22
.SH SEE ALSO
23
.BR libssh2_poll(3)
24