libssh2/share/man/man3/libssh2_poll_channel_read.3

   1 .\" $Id: libssh2_poll_channel_read.3,v 1.2 2007/06/13 12:51:11 jehousley Exp $
   2 .\"
   3 .TH libssh2_poll_channel_read 3 "14 Dec 2006" "libssh2 0.15" "libssh2 manual"
   4 .SH NAME
   5 libssh2_poll_channel_read - check if data is available
   6 .SH SYNOPSIS
   7 #include <libssh2.h>
   8
   9 int libssh2_poll_channel_read(LIBSSH2_CHANNEL *channel, int extended);
  10 .SH DESCRIPTION
  11 \fIlibssh2_poll_channel_read(3)\fP checks to see if data is available in the
  12 \fIchannel\fP's read buffer. No attempt is made with this method to see if
  13 packets are available to be processed. For full polling support, use
  14 \fIlibssh2_poll(3)\fP.
  15 .SH RETURN VALUE
  16 Returns 1 when data is available and 0 otherwise.
  17 .SH SEE ALSO
  18 .BR libssh2_poll(3)