mirror of
https://github.com/libssh2/libssh2.git
synced 2025-10-24 14:53:03 +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
49 lines
1.3 KiB
Markdown
49 lines
1.3 KiB
Markdown
---
|
|
c: Copyright (C) The libssh2 project and its contributors.
|
|
SPDX-License-Identifier: BSD-3-Clause
|
|
Title: libssh2_channel_handle_extended_data2
|
|
Section: 3
|
|
Source: libssh2
|
|
See-also:
|
|
- libssh2_channel_handle_extended_data(3)
|
|
- libssh2_channel_read(3)
|
|
- libssh2_channel_read_ex(3)
|
|
---
|
|
|
|
# NAME
|
|
|
|
libssh2_channel_handle_extended_data2 - set extended data handling mode
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <libssh2.h>
|
|
|
|
int
|
|
libssh2_channel_handle_extended_data2(LIBSSH2_CHANNEL *channel,
|
|
int ignore_mode);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
*channel* - Active channel stream to change extended data handling on.
|
|
|
|
*ignore_mode* - One of the three LIBSSH2_CHANNEL_EXTENDED_DATA_* Constants.
|
|
|
|
**LIBSSH2_CHANNEL_EXTENDED_DATA_NORMAL**: Queue extended data for eventual
|
|
reading
|
|
|
|
**LIBSSH2_CHANNEL_EXTENDED_DATA_MERGE**: Treat extended data and ordinary
|
|
data the same. Merge all substreams such that calls to libssh2_channel_read(3)
|
|
will pull from all substreams on a first-in/first-out basis.
|
|
|
|
**LIBSSH2_CHANNEL_EXTENDED_DATA_IGNORE**: Discard all extended data as it
|
|
arrives.
|
|
|
|
Change how a channel deals with extended data packets. By default all
|
|
extended data is queued until read by libssh2_channel_read_ex(3).
|
|
|
|
# RETURN VALUE
|
|
|
|
Return 0 on success or LIBSSH2_ERROR_EAGAIN when it would otherwise block.
|