libssh2

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

10
void
11
libssh2_channel_handle_extended_data(LIBSSH2_CHANNEL *channel,
12
                                     int ignore_mode);
13
.fi
14
.SH DESCRIPTION
15
This function is \fBDEPRECATED\fP in 1.1.0. Use the
16
\fIlibssh2_channel_handle_extended_data2(3)\fP function instead!
17

18
\fIchannel\fP - Active channel stream to change extended data handling on.
19

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

33
Change how a channel deals with extended data packets. By default all extended
34
data is queued until read by \fIlibssh2_channel_read_ex(3)\fP
35
.SH RETURN VALUE
36
None.
37
.SH SEE ALSO
38
.BR libssh2_channel_handle_extended_data2(3)
39
.BR libssh2_channel_read_ex(3)
40