Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

libssh2_channel_handle_extended_data2 (3ssh2)

Name

libssh2_channel_handle_extended_data2 - set extended data handling mode

Synopsis

#include <libssh2.h>

int libssh2_channel_handle_extended_data2(LIBSSH2_CHANNEL *channel, int
ignore_mode);

Description

libssh2 manual                    libssh2_channel_handle_extended_data2(3ssh2)



NAME
       libssh2_channel_handle_extended_data2 - set extended data handling mode

SYNOPSIS
       #include <libssh2.h>

       int libssh2_channel_handle_extended_data2(LIBSSH2_CHANNEL *channel, int
       ignore_mode);


DESCRIPTION
       channel - Active channel stream to change extended data handling on.

       ignore_mode - One of  the  three  LIBSSH2_CHANNEL_EXTENDED_DATA_*  Con-
       stants.
       LIBSSH2_CHANNEL_EXTENDED_DATA_NORMAL:  Queue extended data for eventual
       reading
       LIBSSH2_CHANNEL_EXTENDED_DATA_MERGE: Treat extended data  and  ordinary
       data  the  same.  Merge all substreams such that calls to libssh2_chan-
       nel_read(3) will pull  from  all  substreams  on  a  first-in/first-out
       basis.
       LIBSSH2_CHANNEL_EXTENDED_DATA_IGNORE:  Discard  all extended data as it
       arrives.

       Change how a channel deals with extended data packets. By  default  all
       extended data is queued until read by libssh2_channel_read_ex(3)


RETURN VALUE
       Return  0  on  success  or LIBSSH2_ERROR_EAGAIN when it would otherwise
       block.



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


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

SEE ALSO
       libssh2_channel_handle_extended_data(3) libssh2_channel_read_ex(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_handle_extended_data2(3ssh2)