mirror of
https://github.com/libssh2/libssh2.git
synced 2025-05-10 07:21:29 +03:00
e590450dcc
- add missing `.fi` tags. - fix misplaced `.nf` tags. - add `.nf`/`.fi` tags `SYNOPSIS` where missing. - fix missing/wrong function name from `SH NAME`. - fix wrong function name in `TH`. - keep return values in a separate line. - indent. - fold long lines. - deleted `libssh2_channel_direct_streamlocal()`, there is no such function. - add missing types. - add missing headers. Closes #949
38 lines
1.2 KiB
Groff
38 lines
1.2 KiB
Groff
.TH libssh2_channel_handle_extended_data 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
|
|
.SH NAME
|
|
libssh2_channel_handle_extended_data - set extended data handling mode
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <libssh2.h>
|
|
|
|
void
|
|
libssh2_channel_handle_extended_data(LIBSSH2_CHANNEL *channel,
|
|
int ignore_mode);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
This function is deprecated. Use the
|
|
\fIlibssh2_channel_handle_extended_data2(3)\fP function instead!
|
|
|
|
\fIchannel\fP - Active channel stream to change extended data handling on.
|
|
|
|
\fIignore_mode\fP - One of the three LIBSSH2_CHANNEL_EXTENDED_DATA_* Constants.
|
|
.br
|
|
\fBLIBSSH2_CHANNEL_EXTENDED_DATA_NORMAL\fP: Queue extended data for eventual
|
|
reading
|
|
.br
|
|
\fBLIBSSH2_CHANNEL_EXTENDED_DATA_MERGE\fP: Treat extended data and ordinary
|
|
data the same. Merge all substreams such that calls to
|
|
\fIlibssh2_channel_read(3)\fP will pull from all substreams on a
|
|
first-in/first-out basis.
|
|
.br
|
|
\fBLIBSSH2_CHANNEL_EXTENDED_DATA_IGNORE\fP: 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 \fIlibssh2_channel_read_ex(3)\fP
|
|
.SH RETURN VALUE
|
|
None.
|
|
.SH SEE ALSO
|
|
.BR libssh2_channel_handle_extended_data2(3)
|
|
.BR libssh2_channel_read_ex(3)
|