libssh2/share/man/man3/libssh2_channel_direct_tcpip_ex.3

   1 .\" $Id: libssh2_channel_direct_tcpip_ex.3,v 1.1 2007/06/13 17:22:15 jehousley Exp $
   2 .\"
   3 .TH libssh2_channel_direct_tcpip_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
   4 .SH NAME
   5 libssh2_channel_direct_tcpip_ex - Tunnel a TCP connection through an SSH session
   6 .SH SYNOPSIS
   7 #include <libssh2.h>
   8
   9 LIBSSH2_CHANNEL *
  10 libssh2_channel_direct_tcpip_ex(LIBSSH2_SESSION *session, const char *host, int port, const char *shost, int sport);
  11
  12 LIBSSH2_CHANNEL *
  13 libssh2_channel_direct_tcpip(LIBSSH2_SESSION *session, const char *host, int port);
  14
  15 .SH DESCRIPTION
  16 /fIsession/fP - Session instance as returned by
  17 .BR libssh2_session_init(3)
  18
  19 /fIhost/fP - Third party host to connect to using the SSH host as a proxy.
  20
  21 /fIport/fP - Port on third party host to connect to.
  22
  23 /fIshost/fP - Host to tell the SSH server the connection originated on.
  24
  25 /fIsport/fP - Port to tell the SSH server the connection originated from.
  26
  27 Tunnel a TCP/IP connection through the SSH transport via the remote host to
  28 a third party. Communication from the client to the SSH server remains
  29 encrypted, communication from the server to the 3rd party host travels
  30 in cleartext.
  31
  32 .SH RETURN VALUE
  33 Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.
  34
  35 .SH ERRORS
  36 \fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
  37
  38 .SH SEE ALSO
  39 .BR libssh2_session_init(3)