libssh2

1
.\" Copyright (C) The libssh2 project and its contributors.
2
.\" SPDX-License-Identifier: BSD-3-Clause
3
.TH libssh2_channel_handle_extended_data2 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
4
.SH NAME
5
libssh2_channel_handle_extended_data2 - set extended data handling mode
6
.SH SYNOPSIS
7
.nf
8
#include <libssh2.h>
9

10
int
11
libssh2_channel_handle_extended_data2(LIBSSH2_CHANNEL *channel,
12
                                      int ignore_mode);
13
.fi
14
.SH DESCRIPTION
15
\fIchannel\fP - Active channel stream to change extended data handling on.
16

17
\fIignore_mode\fP - One of the three LIBSSH2_CHANNEL_EXTENDED_DATA_* Constants.
18
.br
19
\fBLIBSSH2_CHANNEL_EXTENDED_DATA_NORMAL\fP: Queue extended data for eventual
20
reading
21
.br
22
\fBLIBSSH2_CHANNEL_EXTENDED_DATA_MERGE\fP: Treat extended data and ordinary
23
data the same. Merge all substreams such that calls to
24
.BR libssh2_channel_read(3)
25
will pull from all substreams on a first-in/first-out basis.
26
.br
27
\fBLIBSSH2_CHANNEL_EXTENDED_DATA_IGNORE\fP: Discard all extended data as it
28
arrives.
29

30
Change how a channel deals with extended data packets. By default all
31
extended data is queued until read by
32
.BR libssh2_channel_read_ex(3)
33
.SH RETURN VALUE
34
Return 0 on success or LIBSSH2_ERROR_EAGAIN when it would otherwise block.
35
.SH SEE ALSO
36
.BR libssh2_channel_handle_extended_data(3)
37
.BR libssh2_channel_read_ex(3)
38