generic-library/ssh2
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
58abc7e30b
ssh2/docs/libssh2_channel_handle_extended_data.3

38 lines
1.3 KiB
Groff
Raw Normal View History

* Renamed the functions in src/transport.c to be _libssh2_transport_ prefixed and introduced a transport.h header. * Fixed the blocking mode to only change behavior not the actual underlying socket mode so we now always work with non-blocking sockets. This also introduces a new rule of thumb in libssh2 code: we don't call the external function calls internally. We use the internal (non-blocking) ones! * libssh2_channel_receive_window_adjust2 was added and libssh2_channel_receive_window_adjust is now deprecated * Introduced "local" header files with prototypes etc for different parts instead of cramming everything into libssh2_priv.h. channel.h is the first.
2009-03-26 16:41:14 +01:00
.\" $Id: libssh2_channel_handle_extended_data.3,v 1.2 2009/03/26 15:41:16 bagder Exp $
Add libssh2_channel_free.3, libssh2_channel_handle_extended_data.3 and libssh2_channel_handle_extended_data2.3
2007-06-13 22:09:15 +02:00
.\"
.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
#include <libssh2.h>
void
libssh2_channel_handle_extended_data(LIBSSH2_CHANNEL *channel, int ignore_mode);
.SH DESCRIPTION
* Renamed the functions in src/transport.c to be _libssh2_transport_ prefixed and introduced a transport.h header. * Fixed the blocking mode to only change behavior not the actual underlying socket mode so we now always work with non-blocking sockets. This also introduces a new rule of thumb in libssh2 code: we don't call the external function calls internally. We use the internal (non-blocking) ones! * libssh2_channel_receive_window_adjust2 was added and libssh2_channel_receive_window_adjust is now deprecated * Introduced "local" header files with prototypes etc for different parts instead of cramming everything into libssh2_priv.h. channel.h is the first.
2009-03-26 16:41:14 +01:00
This function is deprecated. Use the
\fIlibssh2_channel_handle_extended_data2(3)\fP function instead!
Add libssh2_channel_free.3, libssh2_channel_handle_extended_data.3 and libssh2_channel_handle_extended_data2.3
2007-06-13 22:09:15 +02:00
\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
* Renamed the functions in src/transport.c to be _libssh2_transport_ prefixed and introduced a transport.h header. * Fixed the blocking mode to only change behavior not the actual underlying socket mode so we now always work with non-blocking sockets. This also introduces a new rule of thumb in libssh2 code: we don't call the external function calls internally. We use the internal (non-blocking) ones! * libssh2_channel_receive_window_adjust2 was added and libssh2_channel_receive_window_adjust is now deprecated * Introduced "local" header files with prototypes etc for different parts instead of cramming everything into libssh2_priv.h. channel.h is the first.
2009-03-26 16:41:14 +01:00
\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.
Add libssh2_channel_free.3, libssh2_channel_handle_extended_data.3 and libssh2_channel_handle_extended_data2.3
2007-06-13 22:09:15 +02:00
.br
\fBLIBSSH2_CHANNEL_EXTENDED_DATA_IGNORE\fP: Discard all extended data as it
arrives.
* Renamed the functions in src/transport.c to be _libssh2_transport_ prefixed and introduced a transport.h header. * Fixed the blocking mode to only change behavior not the actual underlying socket mode so we now always work with non-blocking sockets. This also introduces a new rule of thumb in libssh2 code: we don't call the external function calls internally. We use the internal (non-blocking) ones! * libssh2_channel_receive_window_adjust2 was added and libssh2_channel_receive_window_adjust is now deprecated * Introduced "local" header files with prototypes etc for different parts instead of cramming everything into libssh2_priv.h. channel.h is the first.
2009-03-26 16:41:14 +01:00
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
Add libssh2_channel_free.3, libssh2_channel_handle_extended_data.3 and libssh2_channel_handle_extended_data2.3
2007-06-13 22:09:15 +02:00
.SH RETURN VALUE
None.
.SH SEE ALSO
.BR libssh2_channel_handle_extended_data2(3)
.BR libssh2_channel_read_ex(3)
Reference in New Issue Copy Permalink