lib/libssh2
1
0
Fork 0
mirror of https://github.com/libssh2/libssh2.git synced 2025-07-31 00:03:08 +03:00
Code Activity

added three more public functions I found lacking man pages

Browse Source
This commit is contained in:
Daniel Stenberg
2009-03-15 22:59:46 +00:00
parent 0812744424
commit a678dbac06
4 changed files with 81 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/libssh2_channel_window_read_ex.3 Normal file
View File

@ -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 <libssh2.h>
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)