mirror of
https://github.com/libssh2/libssh2.git
synced 2025-11-03 22:13:11 +03:00
592e2b37fa
- simplify `.TH` headers. - delete empty lines before sections. - update template with an `AVAILABILITY` section. Left libssh2 version number in the `.TH` header for entries without an `AVAILABILITY` section, or where there was a different version number there.
36 lines
1.2 KiB
Groff
36 lines
1.2 KiB
Groff
.TH libssh2_channel_handle_extended_data2 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
|
|
.SH NAME
|
|
libssh2_channel_handle_extended_data2 - set extended data handling mode
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <libssh2.h>
|
|
|
|
int
|
|
libssh2_channel_handle_extended_data2(LIBSSH2_CHANNEL *channel,
|
|
int ignore_mode);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
\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
|
|
.BR libssh2_channel_read(3)
|
|
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
|
|
.BR libssh2_channel_read_ex(3)
|
|
.SH RETURN VALUE
|
|
Return 0 on success or LIBSSH2_ERROR_EAGAIN when it would otherwise block.
|
|
.SH SEE ALSO
|
|
.BR libssh2_channel_handle_extended_data(3)
|
|
.BR libssh2_channel_read_ex(3)
|