Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

libssh2_channel_receive_window_adjust2 (3ssh2)

Name

libssh2_channel_receive_window_adjust2 - adjust the channel window

Synopsis

#include <libssh2.h>

int libssh2_channel_receive_window_adjust2(LIBSSH2_CHANNEL * channel,
unsigned long adjustment,
unsigned char force,
unsigned int *window);

Description

libssh2 manual                   libssh2_channel_receive_window_adjust2(3ssh2)



NAME
       libssh2_channel_receive_window_adjust2 - adjust the channel window

SYNOPSIS
       #include <libssh2.h>

       int libssh2_channel_receive_window_adjust2(LIBSSH2_CHANNEL * channel,
                                              unsigned long adjustment,
                                              unsigned char force,
                                              unsigned int *window);


DESCRIPTION
       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.

       This  function stores the new size of the receive window (as understood
       by remote end) in the variable 'window' points to.

RETURN VALUE
       Return 0 on success and a negative value on  error.  If  used  in  non-
       blocking  mode it will return LIBSSH2_ERROR_EAGAIN when it would other-
       wise block.

ERRORS
AVAILABILITY
       Added in libssh2 1.1 since the previous API has deficiencies.


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 1.1                       26 Mar 2009
                                 libssh2_channel_receive_window_adjust2(3ssh2)