libssh2_channel_forward_listen_ex.3 (1848B)
1.TH libssh2_channel_forward_listen_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" 2.SH NAME 3libssh2_channel_forward_listen_ex - listen to inbound connections 4.SH SYNOPSIS 5.nf 6#include <libssh2.h> 7 8LIBSSH2_LISTENER * 9libssh2_channel_forward_listen_ex(LIBSSH2_SESSION *session, 10 char *host, int port, 11 int *bound_port, int queue_maxsize); 12 13LIBSSH2_LISTENER * 14libssh2_channel_forward_listen(LIBSSH2_SESSION *session, int port); 15.fi 16.SH DESCRIPTION 17Instruct the remote SSH server to begin listening for inbound TCP/IP 18connections. New connections will be queued by the library until accepted by 19\fIlibssh2_channel_forward_accept(3)\fP. 20 21\fIsession\fP - instance as returned by libssh2_session_init(). 22 23\fIhost\fP - specific address to bind to on the remote host. Binding to 240.0.0.0 (default when NULL is passed) will bind to all available addresses. 25 26\fIport\fP - port to bind to on the remote host. When 0 is passed, the remote 27host will select the first available dynamic port. 28 29\fIbound_port\fP - Populated with the actual port bound on the remote 30host. Useful when requesting dynamic port numbers. 31 32\fIqueue_maxsize\fP - Maximum number of pending connections to queue before 33rejecting further attempts. 34 35\fIlibssh2_channel_forward_listen(3)\fP is a macro. 36.SH RETURN VALUE 37A newly allocated LIBSSH2_LISTENER instance or NULL on failure. 38.SH ERRORS 39\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. 40 41\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. 42 43\fILIBSSH2_ERROR_PROTO\fP - An invalid SSH protocol response was received on the socket. 44 45\fILIBSSH2_ERROR_REQUEST_DENIED\fP - The remote server refused the request. 46 47\fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call would block. 48.SH SEE ALSO 49.BR libssh2_channel_forward_accept(3)