libssh2_poll_channel_read.3 651 B

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