diff --git a/docs/Makefile.am b/docs/Makefile.am index 3e448aa..8dccf64 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -1,4 +1,4 @@ -# $Id: Makefile.am,v 1.32 2009/02/23 16:22:46 bagder Exp $ +# $Id: Makefile.am,v 1.33 2009/03/15 22:59:46 bagder Exp $ EXTRA_DIST = template.3 @@ -18,12 +18,15 @@ dist_man_MANS = \ libssh2_channel_open_ex.3 \ libssh2_channel_process_startup.3 \ libssh2_channel_read_ex.3 \ + libssh2_channel_receive_window_adjust.3 \ libssh2_channel_request_pty_ex.3 \ libssh2_channel_send_eof.3 \ libssh2_channel_set_blocking.3 \ libssh2_channel_setenv_ex.3 \ libssh2_channel_wait_eof.3 \ libssh2_channel_wait_closed.3 \ + libssh2_channel_window_read_ex.3 \ + libssh2_channel_window_write_ex.3 \ libssh2_channel_write_ex.3 \ libssh2_channel_x11_req_ex.3 \ libssh2_hostkey_hash.3 \ diff --git a/docs/libssh2_channel_receive_window_adjust.3 b/docs/libssh2_channel_receive_window_adjust.3 new file mode 100644 index 0000000..ceabfaf --- /dev/null +++ b/docs/libssh2_channel_receive_window_adjust.3 @@ -0,0 +1,28 @@ +.\" $Id: libssh2_channel_receive_window_adjust.3,v 1.1 2009/03/15 22:59:46 bagder Exp $ +.\" +.TH libssh2_channel_receive_window_adjust 3 "15 Mar 2009" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_receive_window_adjust - adjust the channel window +.SH SYNOPSIS +#include + +unsigned long +libssh2_channel_receive_window_adjust(LIBSSH2_CHANNEL * channel, + unsigned long adjustment, + unsigned char force); + +.SH DESCRIPTION +Adjust the receive window for a channel by adjustment bytes. If the amount to +be adjusted is less than LIBSSH2_CHANNEL_MINADJUST and force is 0 the +adjustment amount will be queued for a later packet. +.SH RETURN VALUE +Returns the new size of the receive window (as understood by remote end). Note +that the window value sent over the wire is strictly 32bit, but this API is +made to return a 'long' which may not be 32 bit on all platforms. +.SH ERRORS +In 1.0 and earlier, this function returns LIBSSH2_ERROR_EAGAIN for +non-blocking channels where it would otherwise block. However, that is a +negative number and this function only returns an unsigned value and this then +leads to a very strange value being returned. +.SH SEE ALSO +libssh2_channel_window_read_ex(3) diff --git a/docs/libssh2_channel_window_read_ex.3 b/docs/libssh2_channel_window_read_ex.3 new file mode 100644 index 0000000..4b70b65 --- /dev/null +++ b/docs/libssh2_channel_window_read_ex.3 @@ -0,0 +1,26 @@ +.\" $Id: libssh2_channel_window_read_ex.3,v 1.1 2009/03/15 22:59:46 bagder Exp $ +.\" +.TH libssh2_channel_window_read_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_window_read_ex - Check the status of the read window +.SH SYNOPSIS +#include + +unsigned long +libssh2_channel_window_read_ex(LIBSSH2_CHANNEL *channel, + unsigned long *read_avail, + unsigned long *window_size_initial) +.SH DESCRIPTION +Check the status of the read window. Returns the number of bytes which the +remote end may send without overflowing the window limit read_avail (if +passed) will be populated with the number of bytes actually available to be +read window_size_initial (if passed) will be populated with the +window_size_initial as defined by the channel_open request +.SH RETURN VALUE +The number of bytes which the remote end may send without overflowing the +window limit +.SH ERRORS + +.SH SEE ALSO +libssh2_channel_receive_window_adjust(3), +libssh2_channel_window_write_ex(3) diff --git a/docs/libssh2_channel_window_write_ex.3 b/docs/libssh2_channel_window_write_ex.3 new file mode 100644 index 0000000..7bcf15f --- /dev/null +++ b/docs/libssh2_channel_window_write_ex.3 @@ -0,0 +1,23 @@ +.\" $Id: libssh2_channel_window_write_ex.3,v 1.1 2009/03/15 22:59:46 bagder Exp $ +.\" +.TH libssh2_channel_window_write_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual" +.SH NAME +libssh2_channel_window_write_ex - Check the status of the write window +.SH SYNOPSIS +#include + +unsigned long +libssh2_channel_window_write_ex(LIBSSH2_CHANNEL *channel, + unsigned long *window_size_initial) +.SH DESCRIPTION +Check the status of the write window Returns the number of bytes which may be +safely writen on the channel without blocking. 'window_size_initial' (if +passed) will be populated with the size of the initial window as defined by +the channel_open request +.SH RETURN VALUE +Number of bytes which may be safely writen on the channel without blocking. +.SH ERRORS + +.SH SEE ALSO +libssh2_channel_window_read_ex(3), +libssh2_channel_receive_window_adjust(3)