libssh2_channel_receive_window_adjust - adjust the channel window
#include <libssh2.h> unsigned long libssh2_channel_receive_window_adjust(LIBSSH2_CHANNEL * channel, unsigned long adjustment, unsigned char force);
libssh2 manual libssh2_channel_receive_window_adjust(3ssh2)
NAME
libssh2_channel_receive_window_adjust - adjust the channel window
SYNOPSIS
#include <libssh2.h>
unsigned long libssh2_channel_receive_window_adjust(LIBSSH2_CHANNEL *
channel,
unsigned long adjustment,
unsigned char force);
DESCRIPTION
This function is deprecated in 1.1. Use libssh2_channel_receive_win-
dow_adjust2(3)!
Adjust the receive window for a channel by adjustment bytes. If the
amount to be adjusted is less than LIBSSH2_CHANNEL_MINADJUST and force
is 0 the adjustment amount will be queued for a later packet.
RETURN VALUE
Returns the new size of the receive window (as understood by remote
end). Note that the window value sent over the wire is strictly 32bit,
but this API is made to return a 'long' which may not be 32 bit on all
platforms.
ERRORS
In 1.0 and earlier, this function returns LIBSSH2_ERROR_EAGAIN for non-
blocking channels where it would otherwise block. However, that is a
negative number and this function only returns an unsigned value and
this then leads to a very strange value being returned.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+------------------+
|Availability | library/libssh2 |
+---------------+------------------+
|Stability | Uncommitted |
+---------------+------------------+
SEE ALSO
libssh2_channel_window_read_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 15 Mar 2009