libssh2_channel_receive_window_adjust.3 (1276B)
1.TH libssh2_channel_receive_window_adjust 3 "15 Mar 2009" "libssh2 0.15" "libssh2" 2.SH NAME 3libssh2_channel_receive_window_adjust - adjust the channel window 4.SH SYNOPSIS 5.nf 6#include <libssh2.h> 7 8unsigned long 9libssh2_channel_receive_window_adjust(LIBSSH2_CHANNEL * channel, 10 unsigned long adjustment, 11 unsigned char force); 12.fi 13.SH DESCRIPTION 14This function is deprecated in 1.1. Use 15\fIlibssh2_channel_receive_window_adjust2(3)\fP! 16 17Adjust the receive window for a channel by adjustment bytes. If the amount to 18be adjusted is less than LIBSSH2_CHANNEL_MINADJUST and force is 0 the 19adjustment amount will be queued for a later packet. 20.SH RETURN VALUE 21Returns the new size of the receive window (as understood by remote end). Note 22that the window value sent over the wire is strictly 32bit, but this API is 23made to return a 'long' which may not be 32 bit on all platforms. 24.SH ERRORS 25In 1.0 and earlier, this function returns LIBSSH2_ERROR_EAGAIN for 26non-blocking channels where it would otherwise block. However, that is a 27negative number and this function only returns an unsigned value and this then 28leads to a very strange value being returned. 29.SH SEE ALSO 30.BR libssh2_channel_window_read_ex(3)