Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

libssh2_channel_flush_ex (3ssh2)

Name

libssh2_channel_flush_ex - flush a channel

Synopsis

#include <libssh2.h>

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);

Description

libssh2 manual                                 libssh2_channel_flush_ex(3ssh2)



NAME
       libssh2_channel_flush_ex - flush a channel

SYNOPSIS
       #include <libssh2.h>

       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);


DESCRIPTION
       channel - Active channel stream to flush.

       streamid - Specific substream number to flush. Groups of substreams may
       be flushed by passing on of the following Constants.
       LIBSSH2_CHANNEL_FLUSH_EXTENDED_DATA: Flush all extended data substreams
       LIBSSH2_CHANNEL_FLUSH_ALL: Flush all substreams

       Flush the read buffer for a given  channel  instance.  Individual  sub-
       streams may be flushed by number or using one of the provided macros.


RETURN VALUE
       Return   0  on  success  or  negative  on  failure.   It  returns  LIB-
       SSH2_ERROR_EAGAIN  when  it   would   otherwise   block.   While   LIB-
       SSH2_ERROR_EAGAIN  is  a negative number, it isn't really a failure per
       se.



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


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

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_flush_ex(3ssh2)