mirror of
https://github.com/libssh2/libssh2.git
synced 2025-11-03 22:13:11 +03:00
b889b39945
To render in Git webviews as-is, to make it easier to edit, verify,
and to sync up with curl.
- add options to not build the `.3` man pages:
- autotools: `--disable-docs`
- cmake: `LIBSSH2_BUILD_DOCS=OFF`
- building `.3` man pages requires Perl after this patch.
- drop `mansyntax` and the shell / `grep` / GNU `man` tool requirements with it.
- scripts and most logic were copied from curl.
- add `cd2nroff` from curl, with edits to relax curl-specific checks.
- used `nroff2cd` (from curl) to convert from `.3` to `.md`. Then
manually fixed copyrights, inline function references and a couple
of other things.
Credits-to: Daniel Stenberg
Ref: eefcc1bda4
Ref: https://github.com/curl/curl/pull/12730
Ref: https://github.com/libssh2/www/issues/25#issuecomment-3289431671
Closes #1660
46 lines
1.2 KiB
Markdown
46 lines
1.2 KiB
Markdown
---
|
|
c: Copyright (C) The libssh2 project and its contributors.
|
|
SPDX-License-Identifier: BSD-3-Clause
|
|
Title: libssh2_channel_receive_window_adjust2
|
|
Section: 3
|
|
Source: libssh2
|
|
See-also:
|
|
- libssh2_channel_window_read_ex(3)
|
|
---
|
|
|
|
# NAME
|
|
|
|
libssh2_channel_receive_window_adjust2 - adjust the channel window
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#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 otherwise block.
|
|
|
|
# ERRORS
|
|
|
|
# AVAILABILITY
|
|
|
|
Added in libssh2 1.1 since the previous API has deficiencies.
|