diff --git a/docs/Makefile.am b/docs/Makefile.am index abcc9da..6d28577 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -1,4 +1,4 @@ -# $Id: Makefile.am,v 1.10 2007/06/13 17:22:15 jehousley Exp $ +# $Id: Makefile.am,v 1.11 2007/06/13 19:53:09 jehousley Exp $ EXTRA_DIST = template.3 @@ -7,7 +7,9 @@ dist_man_MANS = libssh2_channel_close.3 \ libssh2_channel_direct_tcpip_ex.3 \ libssh2_channel_eof.3 \ + libssh2_channel_flush_ex.3 \ libssh2_channel_forward_accept.3 \ + libssh2_channel_forward_cancel.3 \ libssh2_channel_forward_listen_ex.3 \ libssh2_channel_read_ex.3 \ libssh2_channel_set_blocking.3 \ diff --git a/docs/libssh2_channel_flush_ex.3 b/docs/libssh2_channel_flush_ex.3 new file mode 100644 index 0000000..67de921 --- /dev/null +++ b/docs/libssh2_channel_flush_ex.3 @@ -0,0 +1,34 @@ +.\" $Id: libssh2_channel_flush_ex.3,v 1.1 2007/06/13 19:53:09 jehousley Exp $ +.\" +.TH libssh2_channel_flush_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_flush_ex - flush a channel +.SH SYNOPSIS +#include + +int +libssh2_channel_flush_ex(LIBSSH2_CHANNEL *channel, int streamid); + +int +libssh2_channel_flush(LIBSSH2_CHANNEL *channel); + +int +libssh2_channel_flush_stderr(LIBSSH2_CHANNEL *channel); + +.SH DESCRIPTION +\fIchannel\fP - Active channel stream to flush. + +\fIstreamid\fP - Specific substream number to flush. Groups of substreams may +be flushed by passing on of the following Constants. +.br +\fBLIBSSH2_CHANNEL_FLUSH_EXTENDED_DATA\fP: Flush all extended data substreams +.br +\fBLIBSSH2_CHANNEL_FLUSH_ALL\fP: Flush all substreams + +Flush the read buffer for a given channel instance. Individual substreams may +be flushed by number or using one of the provided macros. + +.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. diff --git a/docs/libssh2_channel_forward_cancel.3 b/docs/libssh2_channel_forward_cancel.3 new file mode 100644 index 0000000..822e008 --- /dev/null +++ b/docs/libssh2_channel_forward_cancel.3 @@ -0,0 +1,29 @@ +.\" $Id: libssh2_channel_forward_cancel.3,v 1.1 2007/06/13 19:53:09 jehousley Exp $ +.\" +.TH libssh2_channel_forward_cancel 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_forward_cancel - cancel a forwarded TCP port +.SH SYNOPSIS +#include + +int +libssh2_channel_forward_cancel(LIBSSH2_LISTENER *listener); + +.SH DESCRIPTION +/fIlistener/fP - Forwarding listener instance as returned by +.BR libssh2_channel_forward_listen(3) + +Instruct the remote host to stop listening for new connections on a previously requested host/port. + +.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 ERRORS +\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. + +\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. + +.SH SEE ALSO +.BR libssh2_channel_forward_listen(3)