diff --git a/docs/Makefile.am b/docs/Makefile.am index 6d28577..0d9a344 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -1,4 +1,4 @@ -# $Id: Makefile.am,v 1.11 2007/06/13 19:53:09 jehousley Exp $ +# $Id: Makefile.am,v 1.12 2007/06/13 20:09:15 jehousley Exp $ EXTRA_DIST = template.3 @@ -11,6 +11,9 @@ dist_man_MANS = libssh2_channel_forward_accept.3 \ libssh2_channel_forward_cancel.3 \ libssh2_channel_forward_listen_ex.3 \ + libssh2_channel_free.3 \ + libssh2_channel_handle_extended_data.3 \ + libssh2_channel_handle_extended_data2.3 \ libssh2_channel_read_ex.3 \ libssh2_channel_set_blocking.3 \ libssh2_channel_wait_eof.3 diff --git a/docs/libssh2_channel_free.3 b/docs/libssh2_channel_free.3 new file mode 100644 index 0000000..73f8e1a --- /dev/null +++ b/docs/libssh2_channel_free.3 @@ -0,0 +1,27 @@ +.\" $Id: libssh2_channel_free.3,v 1.1 2007/06/13 20:09:15 jehousley Exp $ +.\" +.TH libssh2_channel_free 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_free - free all resources associated with a channel +.SH SYNOPSIS +#include + +int +libssh2_channel_free(LIBSSH2_CHANNEL *channel); + +.SH DESCRIPTION +\fIchannel\fP - Channel stream to free. + +Release all resources associated with a channel stream. If the channel has +not yet been closed with +.BR libssh2_channel_close(3) +, it will be called automatically so that the remote end may know that it +can safely free its own resources. + +.SH RETURN VALUE +Return 0 on success or negative on failure. It returns +LIBSSH2_ERROR_EAGAIN when it would otherwise block. While +LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. + +.SH SEE ALSO +.BR libssh2_channel_close(3) diff --git a/docs/libssh2_channel_handle_extended_data.3 b/docs/libssh2_channel_handle_extended_data.3 new file mode 100644 index 0000000..9f556eb --- /dev/null +++ b/docs/libssh2_channel_handle_extended_data.3 @@ -0,0 +1,37 @@ +.\" $Id: libssh2_channel_handle_extended_data.3,v 1.1 2007/06/13 20:09:15 jehousley Exp $ +.\" +.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 + +void +libssh2_channel_handle_extended_data(LIBSSH2_CHANNEL *channel, int ignore_mode); + +.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 +None. + +.SH SEE ALSO +.BR libssh2_channel_handle_extended_data2(3) +.BR libssh2_channel_read_ex(3) diff --git a/docs/libssh2_channel_handle_extended_data2.3 b/docs/libssh2_channel_handle_extended_data2.3 new file mode 100644 index 0000000..97d4fd0 --- /dev/null +++ b/docs/libssh2_channel_handle_extended_data2.3 @@ -0,0 +1,37 @@ +.\" $Id: libssh2_channel_handle_extended_data2.3,v 1.1 2007/06/13 20:09:15 jehousley Exp $ +.\" +.TH libssh2_channel_handle_extended_data2 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_handle_extended_data2 - set extended data handling mode +.SH SYNOPSIS +#include + +int +libssh2_channel_handle_extended_data2(LIBSSH2_CHANNEL *channel, int ignore_mode); + +.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)