libssh2

1
.\" Copyright (C) The libssh2 project and its contributors.
2
.\" SPDX-License-Identifier: BSD-3-Clause
3
.TH libssh2_channel_receive_window_adjust 3 "15 Mar 2009" "libssh2 0.15" "libssh2"
4
.SH NAME
5
libssh2_channel_receive_window_adjust - adjust the channel window
6
.SH SYNOPSIS
7
.nf
8
#include <libssh2.h>
9

10
unsigned long
11
libssh2_channel_receive_window_adjust(LIBSSH2_CHANNEL * channel,
12
                                      unsigned long adjustment,
13
                                      unsigned char force);
14
.fi
15
.SH DESCRIPTION
16
This function is \fBDEPRECATED\fP in 1.1.0. Use the
17
\fIlibssh2_channel_receive_window_adjust2(3)\fP function instead!
18

19
Adjust the receive window for a channel by adjustment bytes. If the amount to
20
be adjusted is less than LIBSSH2_CHANNEL_MINADJUST and force is 0 the
21
adjustment amount will be queued for a later packet.
22
.SH RETURN VALUE
23
Returns the new size of the receive window (as understood by remote end). Note
24
that the window value sent over the wire is strictly 32bit, but this API is
25
made to return a 'long' which may not be 32 bit on all platforms.
26
.SH ERRORS
27
In 1.0 and earlier, this function returns LIBSSH2_ERROR_EAGAIN for
28
non-blocking channels where it would otherwise block. However, that is a
29
negative number and this function only returns an unsigned value and this then
30
leads to a very strange value being returned.
31
.SH SEE ALSO
32
.BR libssh2_channel_window_read_ex(3)
33