Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

libssh2_channel_window_write_ex (3ssh2)

Name

libssh2_channel_window_write_ex - Check the status of the write window

Synopsis

#include <libssh2.h>

unsigned long libssh2_channel_window_write_ex(LIBSSH2_CHANNEL *channel,
unsigned long *window_size_initial)

Description

libssh2 manual                          libssh2_channel_window_write_ex(3ssh2)



NAME
       libssh2_channel_window_write_ex - Check the status of the write window

SYNOPSIS
       #include <libssh2.h>

       unsigned long libssh2_channel_window_write_ex(LIBSSH2_CHANNEL *channel,
                                       unsigned long *window_size_initial)

DESCRIPTION
       Check  the status of the write window Returns the number of bytes which
       may  be  safely  written  on  the  channel  without   blocking.   'win-
       dow_size_initial'  (if  passed)  will be populated with the size of the
       initial window as defined by the channel_open request

RETURN VALUE
       Number of bytes which may be safely  written  on  the  channel  without
       blocking.

ERRORS
ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/libssh2  |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       libssh2_channel_window_read_ex(3),         libssh2_channel_receive_win-
       dow_adjust(3)



NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source  was  downloaded   from    https://www.libssh2.org/download/lib-
       ssh2-1.10.0.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.libssh2.org/.



libssh2 0.15                      1 Jun 2007
                                        libssh2_channel_window_write_ex(3ssh2)