libssh2_channel_window_read_ex - Check the status of the read window
#include <libssh2.h> unsigned long libssh2_channel_window_read_ex(LIBSSH2_CHANNEL *channel, unsigned long *read_avail, unsigned long *window_size_initial)
libssh2 manual libssh2_channel_window_read_ex(3ssh2)
NAME
libssh2_channel_window_read_ex - Check the status of the read window
SYNOPSIS
#include <libssh2.h>
unsigned long libssh2_channel_window_read_ex(LIBSSH2_CHANNEL *channel,
unsigned long *read_avail,
unsigned long *window_size_initial)
DESCRIPTION
Check the status of the read window. Returns the number of bytes which
the remote end may send without overflowing the window limit read_avail
(if passed) will be populated with the number of bytes actually avail-
able to be read window_size_initial (if passed) will be populated with
the window_size_initial as defined by the channel_open request
RETURN VALUE
The number of bytes which the remote end may send without overflowing
the window limit
ERRORS
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+------------------+
|Availability | library/libssh2 |
+---------------+------------------+
|Stability | Uncommitted |
+---------------+------------------+
SEE ALSO
libssh2_channel_receive_window_adjust(3), libssh2_channel_win-
dow_write_ex(3)
NOTES
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from https://www.libssh2.org/download/lib-
ssh2-1.10.0.tar.gz.
Further information about this software can be found on the open source
community website at https://www.libssh2.org/.
libssh2 0.15 1 Jun 2007
libssh2_channel_window_read_ex(3ssh2)