libssh2_channel_open_ex.3 (1955B)
1.TH libssh2_channel_open_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" 2.SH NAME 3libssh2_channel_open_ex - establish a generic session channel 4.SH SYNOPSIS 5.nf 6#include <libssh2.h> 7 8LIBSSH2_CHANNEL * 9libssh2_channel_open_ex(LIBSSH2_SESSION *session, const char *channel_type, 10 unsigned int channel_type_len, 11 unsigned int window_size, 12 unsigned int packet_size, 13 const char *message, unsigned int message_len); 14 15LIBSSH2_CHANNEL * 16libssh2_channel_open_session(session); 17.fi 18.SH DESCRIPTION 19\fIsession\fP - Session instance as returned by 20.BR libssh2_session_init_ex(3) 21 22\fIchannel_type\fP - Channel type to open. Typically one of session, 23direct-tcpip, or tcpip-forward. The SSH2 protocol allowed for additional 24types including local, custom channel types. 25 26\fIchannel_type_len\fP - Length of channel_type 27 28\fIwindow_size\fP - Maximum amount of unacknowledged data remote host is 29allowed to send before receiving an SSH_MSG_CHANNEL_WINDOW_ADJUST packet. 30 31\fIpacket_size\fP - Maximum number of bytes remote host is allowed to send 32in a single SSH_MSG_CHANNEL_DATA or SSG_MSG_CHANNEL_EXTENDED_DATA packet. 33 34\fImessage\fP - Additional data as required by the selected channel_type. 35 36\fImessage_len\fP - Length of message parameter. 37 38Allocate a new channel for exchanging data with the server. This method is 39typically called through its macroized form: 40.BR libssh2_channel_open_session(3) 41or via 42.BR libssh2_channel_direct_tcpip(3) 43or 44.BR libssh2_channel_forward_listen(3) 45.SH RETURN VALUE 46Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors. 47.SH ERRORS 48\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. 49 50\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. 51 52\fILIBSSH2_ERROR_CHANNEL_FAILURE\fP - 53 54\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would block. 55.SH SEE ALSO 56Add related functions