com.jcraft.jsch

Class ChannelDirectTCPIP

java.lang.Object

com.jcraft.jsch.Channel

com.jcraft.jsch.ChannelDirectTCPIP

All Implemented Interfaces:

Runnable

public class ChannelDirectTCPIP
extends Channel

A Channel which allows forwarding a pair of local streams to/from a TCP-connection to a server on the remote side. This class is used internally by the local port forwarding, but it also can be used directly by client software to forward a pair of InputStream and OutputStream.

See Also:

Session.openChannel("direct-tcpip"), Session.setPortForwardingL(String, int, String, int), RFC 4254, section 7.2 TCP/IP Forwarding Channels

Field Summary

Fields inherited from class com.jcraft.jsch.Channel

type

Method Summary

Modifier and Type	Method and Description
void	connect(int connectTimeout) opens the channel.
protected com.jcraft.jsch.Packet	genChannelOpenPacket()
void	run() Not for external use - the channel transfer loop.
void	setHost(String host) Sets the remote host name (or IP address) to connect to (which should be valid at the remote side).
void	setInputStream(InputStream in) Sets the InputStream to be forwarded.
void	setOrgIPAddress(String foo) Sets the local originator IP address we pretend the connection came from.
void	setOrgPort(int foo) Sets the local originator port number we pretend the connection came from.
void	setOutputStream(OutputStream out) Sets the OutputStream to be forwarded.
void	setPort(int port) Sets the remote port number to connect to.

Methods inherited from class com.jcraft.jsch.Channel

connect, disconnect, getExitStatus, getExtInputStream, getId, getInputStream, getOutputStream, getSession, isClosed, isConnected, isEOF, sendChannelOpen, sendOpenConfirmation, sendOpenFailure, sendSignal, setExtOutputStream, setExtOutputStream, setInputStream, setOutputStream, setXForwarding, start

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

connect

public void connect(int connectTimeout)
             throws JSchException

opens the channel.

Overrides:

connect in class Channel

Parameters:

connectTimeout - the maximum time to wait for the channel to be established, in milliseconds. If 0, we wait as long as needed (but at most 1000 times 50 milliseconds each).

Throws:

JSchException - if a timeout occured, or some other connection problem.

run

public void run()

Not for external use - the channel transfer loop.

Specified by:

run in interface Runnable

Overrides:

run in class Channel

setInputStream

public void setInputStream(InputStream in)

Sets the InputStream to be forwarded. Everything read from this stream is forwarded to the remote server. This should be called before connect(int).

Overrides:

setInputStream in class Channel

setOutputStream

public void setOutputStream(OutputStream out)

Sets the OutputStream to be forwarded. Everything sent by the remote server will be written to this stream. This should be called before connect(int).

Overrides:

setOutputStream in class Channel

See Also:

Channel.getInputStream()

setHost

public void setHost(String host)

Sets the remote host name (or IP address) to connect to (which should be valid at the remote side). This should be called before connect(int).

See Also:

setPort(int)

setPort

public void setPort(int port)

Sets the remote port number to connect to. This should be called before connect(int).

See Also:

setHost(java.lang.String)

setOrgIPAddress

public void setOrgIPAddress(String foo)

Sets the local originator IP address we pretend the connection came from. The default value is "127.0.0.1". This should be called before connect(int).

See Also:

setOrgPort(int)

setOrgPort

public void setOrgPort(int foo)

Sets the local originator port number we pretend the connection came from. The default value is 0. This should be called before connect(int).

See Also:

setOrgIPAddress(java.lang.String)

genChannelOpenPacket

protected com.jcraft.jsch.Packet genChannelOpenPacket()

Overrides:

genChannelOpenPacket in class Channel