libssh2

1
.\" Copyright (C) The libssh2 project and its contributors.
2
.\" SPDX-License-Identifier: BSD-3-Clause
3
.TH libssh2_channel_open_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2"
4
.SH NAME
5
libssh2_channel_open_ex - establish a generic session channel
6
.SH SYNOPSIS
7
.nf
8
#include <libssh2.h>
9

10
LIBSSH2_CHANNEL *
11
libssh2_channel_open_ex(LIBSSH2_SESSION *session, const char *channel_type,
12
                        unsigned int channel_type_len,
13
                        unsigned int window_size,
14
                        unsigned int packet_size,
15
                        const char *message, unsigned int message_len);
16

17
LIBSSH2_CHANNEL *
18
libssh2_channel_open_session(session);
19
.fi
20
.SH DESCRIPTION
21
\fIsession\fP - Session instance as returned by
22
.BR libssh2_session_init_ex(3)
23

24
\fIchannel_type\fP - Channel type to open. Typically one of session,
25
direct-tcpip, or tcpip-forward. The SSH2 protocol allowed for additional
26
types including local, custom channel types.
27

28
\fIchannel_type_len\fP - Length of channel_type
29

30
\fIwindow_size\fP - Maximum amount of unacknowledged data remote host is
31
allowed to send before receiving an SSH_MSG_CHANNEL_WINDOW_ADJUST packet.
32

33
\fIpacket_size\fP - Maximum number of bytes remote host is allowed to send
34
in a single SSH_MSG_CHANNEL_DATA or SSG_MSG_CHANNEL_EXTENDED_DATA packet.
35

36
\fImessage\fP - Additional data as required by the selected channel_type.
37

38
\fImessage_len\fP - Length of message parameter.
39

40
Allocate a new channel for exchanging data with the server. This method is
41
typically called through its macroized form:
42
.BR libssh2_channel_open_session(3)
43
or via
44
.BR libssh2_channel_direct_tcpip(3)
45
or
46
.BR libssh2_channel_forward_listen(3)
47
.SH RETURN VALUE
48
Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.
49
.SH ERRORS
50
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
51

52
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
53

54
\fILIBSSH2_ERROR_CHANNEL_FAILURE\fP -
55

56
\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would block.
57
.SH SEE ALSO
58
Add related functions
59