libssh2/docs/libssh2_channel_handle_extended_data2.md

c, SPDX-License-Identifier, Title, Section, Source, See-also

c	SPDX-License-Identifier	Title	Section	Source	See-also
Copyright (C) The libssh2 project and its contributors.	BSD-3-Clause	libssh2_channel_handle_extended_data2	3	libssh2	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

#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) pulls 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.