libssh2_channel_flush_ex.3 (1045B)
1.TH libssh2_channel_flush_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" 2.SH NAME 3libssh2_channel_flush_ex - flush a channel 4.SH SYNOPSIS 5.nf 6#include <libssh2.h> 7 8int 9libssh2_channel_flush_ex(LIBSSH2_CHANNEL *channel, int streamid); 10 11int 12libssh2_channel_flush(LIBSSH2_CHANNEL *channel); 13 14int 15libssh2_channel_flush_stderr(LIBSSH2_CHANNEL *channel); 16.fi 17.SH DESCRIPTION 18\fIchannel\fP - Active channel stream to flush. 19 20\fIstreamid\fP - Specific substream number to flush. Groups of substreams may 21be flushed by passing on of the following Constants. 22.br 23\fBLIBSSH2_CHANNEL_FLUSH_EXTENDED_DATA\fP: Flush all extended data substreams 24.br 25\fBLIBSSH2_CHANNEL_FLUSH_ALL\fP: Flush all substreams 26 27Flush the read buffer for a given channel instance. Individual substreams may 28be flushed by number or using one of the provided macros. 29.SH RETURN VALUE 30Return the number of bytes flushed or negative on failure. 31It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While 32LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se.