1libssh2_channel_write_ex(3)     libssh2 manual     libssh2_channel_write_ex(3)
2
3
4

NAME

6       libssh2_channel_write_ex - write data to a channel stream blocking
7

SYNOPSIS

9       #include <libssh2.h>
10
11       ssize_t libssh2_channel_write_ex(LIBSSH2_CHANNEL *channel,
12                                        int stream_id, char *buf,
13                                        size_t buflen);
14

DESCRIPTION

16       Write  data  to a channel stream. All channel streams have one standard
17       I/O substream (stream_id == 0), and may have up to 2^32  extended  data
18       streams as identified by the selected stream_id. The SSH2 protocol cur‐
19       rently defines a stream ID of 1 to be the stderr substream.
20
21       channel - active channel stream to write to.
22
23       stream_id - substream ID number (e.g. 0 or SSH_EXTENDED_DATA_STDERR)
24
25       buf - pointer to buffer to write
26
27       buflen - size of the data to write
28
29       libssh2_channel_write(3) and libssh2_channel_write_stderr(3) are conve‐
30       nience macros for this function.
31
32       libssh2_channel_write_ex(3)  will use as much as possible of the buffer
33       and put it into a single SSH protocol packet. This means  that  to  get
34       maximum performance when sending larger files, you should try to always
35       pass in at least 32K of data to this function.
36

RETURN VALUE

38       Actual  number  of  bytes  written  or  negative  on   failure.    LIB‐
39       SSH2_ERROR_EAGAIN   when   it   would   otherwise   block.  While  LIB‐
40       SSH2_ERROR_EAGAIN is a negative number, it isn't really a  failure  per
41       se.
42

ERRORS

44       LIBSSH2_ERROR_ALLOC - An internal memory allocation call failed.
45
46       LIBSSH2_ERROR_SOCKET_SEND - Unable to send data on socket.
47
48       LIBSSH2_ERROR_CHANNEL_CLOSED - The channel has been closed.
49
50       LIBSSH2_ERROR_CHANNEL_EOF_SENT  -  The channel has been requested to be
51       closed.
52

SEE ALSO

54       libssh2_channel_open_ex(3) libssh2_channel_read_ex(3)
55
56
57
58libssh2 0.15                      1 Jun 2007       libssh2_channel_write_ex(3)
Impressum