libssh2/share/man/man3/libssh2_channel_handle_extended_data2.3

   1 .\" $Id: libssh2_channel_handle_extended_data2.3,v 1.1 2007/06/13 20:09:15 jehousley Exp $
   2 .\"
   3 .TH libssh2_channel_handle_extended_data2 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
   4 .SH NAME
   5 libssh2_channel_handle_extended_data2 - set extended data handling mode
   6 .SH SYNOPSIS
   7 #include <libssh2.h>
   8
   9 int
  10 libssh2_channel_handle_extended_data2(LIBSSH2_CHANNEL *channel, int ignore_mode);
  11
  12 .SH DESCRIPTION
  13 \fIchannel\fP - Active channel stream to change extended data handling on.
  14
  15 \fIignore_mode\fP - One of the three LIBSSH2_CHANNEL_EXTENDED_DATA_* Constants.
  16 .br
  17 \fBLIBSSH2_CHANNEL_EXTENDED_DATA_NORMAL\fP: Queue extended data for eventual
  18 reading
  19 .br
  20 \fBLIBSSH2_CHANNEL_EXTENDED_DATA_MERGE\fP: Treat extended data and ordinary
  21 data the same. Merge all substreams such that calls to
  22 .BR libssh2_channel_read(3)
  23 will pull from all substreams on a first-in/first-out basis.
  24 .br
  25 \fBLIBSSH2_CHANNEL_EXTENDED_DATA_IGNORE\fP: Discard all extended data as it
  26 arrives.
  27
  28 Change how a channel deals with extended data packets. By default all
  29 extended data is queued until read by
  30 .BR libssh2_channel_read_ex(3)
  31
  32 .SH RETURN VALUE
  33 Return 0 on success or LIBSSH2_ERROR_EAGAIN when it would otherwise block.
  34
  35 .SH SEE ALSO
  36 .BR libssh2_channel_handle_extended_data(3)
  37 .BR libssh2_channel_read_ex(3)