com.jcraft.jsch.ChannelDirectTCPIP Class Reference

A Channel which allows forwarding a pair of local streams to/from a TCP-connection to a server on the remote side. More...

Inheritance diagram for com.jcraft.jsch.ChannelDirectTCPIP:
Inheritance graph
[legend]
Collaboration diagram for com.jcraft.jsch.ChannelDirectTCPIP:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void connect () throws JSchException
 opens the channel.
void run ()
 Not for external use - the channel transfer loop.
void setInputStream (InputStream in)
 Sets the InputStream to be forwarded.
void setOutputStream (OutputStream out)
 Sets the OutputStream to be forwarded.
void setHost (String host)
 Sets the remote host name (or IP address) to connect to (which should be valid at the remote side).
void setPort (int port)
 Sets the remote port number to connect to.

Protected Attributes

byte[] type = Util.str2byte("foo")

Package Functions

 ChannelDirectTCPIP ()
void init ()
synchronized void setRecipient (int foo)
int getRecipient ()

Static Package Functions

static Channel getChannel (String type)
 Creates a new Channel of specified type.
static Channel getChannel (int id, Session session)
 Retrieves a channel from the channel pool.
static void del (Channel c)
 Removes a channel from the channel pool.

Package Attributes

String host
int port
String originator_IP_address = "127.0.0.1"
int originator_port = 0
int id
volatile int recipient = -1
volatile int lwsize_max = 0x100000
volatile int lwsize = lwsize_max
volatile int lmpsize = 0x4000
volatile long rwsize = 0
volatile int rmpsize = 0
IO io = null
Thread thread = null
volatile boolean eof_local = false
volatile boolean eof_remote = false
volatile boolean close = false
volatile boolean connected = false
volatile boolean open_confirmation = false
volatile int exitstatus = -1
volatile int reply = 0
volatile int connectTimeout = 0
int notifyme = 0

Static Package Attributes

static final int SSH_MSG_CHANNEL_OPEN_CONFIRMATION = 91
static final int SSH_MSG_CHANNEL_OPEN_FAILURE = 92
static final int SSH_MSG_CHANNEL_WINDOW_ADJUST = 93
static final int SSH_OPEN_ADMINISTRATIVELY_PROHIBITED = 1
static final int SSH_OPEN_CONNECT_FAILED = 2
static final int SSH_OPEN_UNKNOWN_CHANNEL_TYPE = 3
static final int SSH_OPEN_RESOURCE_SHORTAGE = 4
static int index = 0

Static Private Attributes

static final int LOCAL_WINDOW_SIZE_MAX = 0x20000
static final int LOCAL_MAXIMUM_PACKET_SIZE = 0x4000

Detailed Description

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 Session.openChannel("direct-tcpip")
Session.setPortForwardingL(String, int, String, int)
RFC 4254, section 7.2 TCP/IP Forwarding Channels

Definition at line 47 of file ChannelDirectTCPIP.java.

Constructor & Destructor Documentation

com.jcraft.jsch.ChannelDirectTCPIP.ChannelDirectTCPIP (  )  [package]

Definition at line 58 of file ChannelDirectTCPIP.java.

References com.jcraft.jsch.ChannelDirectTCPIP.LOCAL_MAXIMUM_PACKET_SIZE, and com.jcraft.jsch.ChannelDirectTCPIP.LOCAL_WINDOW_SIZE_MAX.

Member Function Documentation

void com.jcraft.jsch.ChannelDirectTCPIP.connect (  )  throws JSchException

opens the channel.

Reimplemented from com.jcraft.jsch.Channel.

Definition at line 77 of file ChannelDirectTCPIP.java.

References com.jcraft.jsch.IO.close(), com.jcraft.jsch.Channel.connected, com.jcraft.jsch.Channel.connectTimeout, com.jcraft.jsch.Session.daemon_thread, com.jcraft.jsch.Channel.getRecipient(), com.jcraft.jsch.ChannelDirectTCPIP.host, com.jcraft.jsch.IO.in, com.jcraft.jsch.Channel.io, com.jcraft.jsch.Session.isConnected, com.jcraft.jsch.Session.jsch, com.jcraft.jsch.Channel.lmpsize, com.jcraft.jsch.Channel.lwsize, com.jcraft.jsch.Channel.notifyme, com.jcraft.jsch.Channel.open_confirmation, com.jcraft.jsch.ChannelDirectTCPIP.originator_IP_address, com.jcraft.jsch.ChannelDirectTCPIP.originator_port, com.jcraft.jsch.ChannelDirectTCPIP.port, com.jcraft.jsch.Buffer.putByte(), com.jcraft.jsch.Packet.reset(), and com.jcraft.jsch.Channel.thread.

Referenced by com.jcraft.jsch.PortWatcher.run().

static void com.jcraft.jsch.Channel.del ( Channel  c  )  [static, package, inherited]

Removes a channel from the channel pool.

Definition at line 116 of file Channel.java.

References com.jcraft.jsch.Channel.pool.

static Channel com.jcraft.jsch.Channel.getChannel ( int  id,
Session  session 
) [static, package, inherited]

Retrieves a channel from the channel pool.

Parameters:
id the session-specific identifier of the channel
session the session with which the channel is associated.

Definition at line 103 of file Channel.java.

References com.jcraft.jsch.Channel.id, com.jcraft.jsch.Channel.pool, and com.jcraft.jsch.Channel.session.

static Channel com.jcraft.jsch.Channel.getChannel ( String  type  )  [static, package, inherited]

Creates a new Channel of specified type.

This factory method is used by Session#openChannel to create channels.

Definition at line 67 of file Channel.java.

int com.jcraft.jsch.Channel.getRecipient (  )  [package, inherited]

Definition at line 162 of file Channel.java.

References com.jcraft.jsch.Channel.recipient.

Referenced by com.jcraft.jsch.ChannelDirectTCPIP.connect(), com.jcraft.jsch.RequestX11.request(), com.jcraft.jsch.RequestWindowChange.request(), com.jcraft.jsch.RequestSubsystem.request(), com.jcraft.jsch.RequestSignal.request(), com.jcraft.jsch.RequestShell.request(), com.jcraft.jsch.RequestSftp.request(), com.jcraft.jsch.RequestPtyReq.request(), com.jcraft.jsch.RequestExec.request(), com.jcraft.jsch.RequestEnv.request(), and com.jcraft.jsch.RequestAgentForwarding.request().

void com.jcraft.jsch.ChannelDirectTCPIP.init (  )  [package]

Reimplemented from com.jcraft.jsch.Channel.

Definition at line 65 of file ChannelDirectTCPIP.java.

References com.jcraft.jsch.Channel.io.

Referenced by com.jcraft.jsch.PortWatcher.run().

void com.jcraft.jsch.ChannelDirectTCPIP.run (  ) 

Not for external use - the channel transfer loop.

Definition at line 172 of file ChannelDirectTCPIP.java.

References com.jcraft.jsch.Buffer.buffer, com.jcraft.jsch.Channel.close, com.jcraft.jsch.IO.in, com.jcraft.jsch.Channel.io, com.jcraft.jsch.Buffer.putByte(), com.jcraft.jsch.Channel.recipient, com.jcraft.jsch.Packet.reset(), com.jcraft.jsch.Channel.rmpsize, and com.jcraft.jsch.Channel.thread.

void com.jcraft.jsch.ChannelDirectTCPIP.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.

See also:
setPort

Definition at line 236 of file ChannelDirectTCPIP.java.

void com.jcraft.jsch.ChannelDirectTCPIP.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.

Definition at line 215 of file ChannelDirectTCPIP.java.

References com.jcraft.jsch.Channel.io, and com.jcraft.jsch.IO.setInputStream().

Referenced by com.jcraft.jsch.PortWatcher.run().

void com.jcraft.jsch.ChannelDirectTCPIP.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.

Definition at line 225 of file ChannelDirectTCPIP.java.

References com.jcraft.jsch.Channel.io, and com.jcraft.jsch.IO.setOutputStream().

Referenced by com.jcraft.jsch.PortWatcher.run().

void com.jcraft.jsch.ChannelDirectTCPIP.setPort ( int  port  ) 

Sets the remote port number to connect to.

This should be called before connect.

See also:
setHost

Definition at line 244 of file ChannelDirectTCPIP.java.

synchronized void com.jcraft.jsch.Channel.setRecipient ( int  foo  )  [package, inherited]

Definition at line 157 of file Channel.java.

References com.jcraft.jsch.Channel.notifyme, and com.jcraft.jsch.Channel.recipient.

Referenced by com.jcraft.jsch.ChannelForwardedTCPIP.getData().

Member Data Documentation

volatile boolean com.jcraft.jsch.Channel.close = false [package, inherited]

Definition at line 138 of file Channel.java.

Referenced by com.jcraft.jsch.ChannelX11.run(), com.jcraft.jsch.ChannelSession.run(), com.jcraft.jsch.ChannelForwardedTCPIP.run(), com.jcraft.jsch.ChannelDirectTCPIP.run(), and com.jcraft.jsch.ChannelAgentForwarding.run().

volatile boolean com.jcraft.jsch.Channel.connected = false [package, inherited]

Definition at line 139 of file Channel.java.

Referenced by com.jcraft.jsch.ChannelAgentForwarding.ChannelAgentForwarding(), com.jcraft.jsch.ChannelForwardedTCPIP.ChannelForwardedTCPIP(), com.jcraft.jsch.ChannelX11.ChannelX11(), and com.jcraft.jsch.ChannelDirectTCPIP.connect().

volatile int com.jcraft.jsch.Channel.connectTimeout = 0 [package, inherited]

Definition at line 145 of file Channel.java.

Referenced by com.jcraft.jsch.ChannelDirectTCPIP.connect(), com.jcraft.jsch.Request.request(), and com.jcraft.jsch.Request.write().

volatile boolean com.jcraft.jsch.Channel.eof_local = false [package, inherited]

Definition at line 135 of file Channel.java.

volatile boolean com.jcraft.jsch.Channel.eof_remote = false [package, inherited]

Definition at line 136 of file Channel.java.

volatile int com.jcraft.jsch.Channel.exitstatus = -1 [package, inherited]

Definition at line 142 of file Channel.java.

Referenced by com.jcraft.jsch.PortWatcher.run().

String com.jcraft.jsch.ChannelDirectTCPIP.host [package]

Definition at line 52 of file ChannelDirectTCPIP.java.

Referenced by com.jcraft.jsch.ChannelDirectTCPIP.connect().

int com.jcraft.jsch.Channel.id [package, inherited]

Definition at line 122 of file Channel.java.

Referenced by com.jcraft.jsch.Channel.getChannel().

int com.jcraft.jsch.Channel.index = 0 [static, package, inherited]

Definition at line 60 of file Channel.java.

Referenced by com.jcraft.jsch.Channel.Channel().

IO com.jcraft.jsch.Channel.io = null [package, inherited]

Definition at line 132 of file Channel.java.

Referenced by com.jcraft.jsch.ChannelForwardedTCPIP.ChannelForwardedTCPIP(), com.jcraft.jsch.ChannelSession.ChannelSession(), com.jcraft.jsch.ChannelDirectTCPIP.connect(), com.jcraft.jsch.ChannelSubsystem.init(), com.jcraft.jsch.ChannelShell.init(), com.jcraft.jsch.ChannelExec.init(), com.jcraft.jsch.ChannelDirectTCPIP.init(), com.jcraft.jsch.ChannelX11.run(), com.jcraft.jsch.ChannelSession.run(), com.jcraft.jsch.ChannelForwardedTCPIP.run(), com.jcraft.jsch.ChannelDirectTCPIP.run(), com.jcraft.jsch.ChannelDirectTCPIP.setInputStream(), com.jcraft.jsch.ChannelDirectTCPIP.setOutputStream(), com.jcraft.jsch.ChannelSubsystem.start(), com.jcraft.jsch.ChannelShell.start(), com.jcraft.jsch.ChannelExec.start(), and com.jcraft.jsch.ChannelX11.write().

volatile int com.jcraft.jsch.Channel.lmpsize = 0x4000 [package, inherited]

Definition at line 127 of file Channel.java.

Referenced by com.jcraft.jsch.ChannelDirectTCPIP.connect().

final int com.jcraft.jsch.ChannelDirectTCPIP.LOCAL_MAXIMUM_PACKET_SIZE = 0x4000 [static, private]

Definition at line 50 of file ChannelDirectTCPIP.java.

Referenced by com.jcraft.jsch.ChannelDirectTCPIP.ChannelDirectTCPIP().

final int com.jcraft.jsch.ChannelDirectTCPIP.LOCAL_WINDOW_SIZE_MAX = 0x20000 [static, private]

Definition at line 49 of file ChannelDirectTCPIP.java.

Referenced by com.jcraft.jsch.ChannelDirectTCPIP.ChannelDirectTCPIP().

volatile int com.jcraft.jsch.Channel.lwsize = lwsize_max [package, inherited]

Definition at line 126 of file Channel.java.

Referenced by com.jcraft.jsch.ChannelDirectTCPIP.connect().

volatile int com.jcraft.jsch.Channel.lwsize_max = 0x100000 [package, inherited]

Definition at line 125 of file Channel.java.

int com.jcraft.jsch.Channel.notifyme = 0 [package, inherited]

Definition at line 149 of file Channel.java.

Referenced by com.jcraft.jsch.ChannelDirectTCPIP.connect(), and com.jcraft.jsch.Channel.setRecipient().

volatile boolean com.jcraft.jsch.Channel.open_confirmation = false [package, inherited]

Definition at line 140 of file Channel.java.

Referenced by com.jcraft.jsch.ChannelDirectTCPIP.connect().

String com.jcraft.jsch.ChannelDirectTCPIP.originator_IP_address = "127.0.0.1" [package]

Definition at line 55 of file ChannelDirectTCPIP.java.

Referenced by com.jcraft.jsch.ChannelDirectTCPIP.connect().

int com.jcraft.jsch.ChannelDirectTCPIP.originator_port = 0 [package]

Definition at line 56 of file ChannelDirectTCPIP.java.

Referenced by com.jcraft.jsch.ChannelDirectTCPIP.connect().

int com.jcraft.jsch.ChannelDirectTCPIP.port [package]

Definition at line 53 of file ChannelDirectTCPIP.java.

Referenced by com.jcraft.jsch.ChannelDirectTCPIP.connect().

volatile int com.jcraft.jsch.Channel.recipient = -1 [package, inherited]

Definition at line 123 of file Channel.java.

Referenced by com.jcraft.jsch.Channel.getRecipient(), com.jcraft.jsch.ChannelX11.run(), com.jcraft.jsch.ChannelSession.run(), com.jcraft.jsch.ChannelForwardedTCPIP.run(), com.jcraft.jsch.ChannelDirectTCPIP.run(), com.jcraft.jsch.ChannelAgentForwarding.send(), and com.jcraft.jsch.Channel.setRecipient().

volatile int com.jcraft.jsch.Channel.reply = 0 [package, inherited]

Definition at line 144 of file Channel.java.

Referenced by com.jcraft.jsch.Request.write().

volatile int com.jcraft.jsch.Channel.rmpsize = 0 [package, inherited]

Definition at line 130 of file Channel.java.

Referenced by com.jcraft.jsch.ChannelX11.run(), com.jcraft.jsch.ChannelSession.run(), com.jcraft.jsch.ChannelForwardedTCPIP.run(), com.jcraft.jsch.ChannelDirectTCPIP.run(), and com.jcraft.jsch.ChannelAgentForwarding.write().

volatile long com.jcraft.jsch.Channel.rwsize = 0 [package, inherited]

Definition at line 129 of file Channel.java.

final int com.jcraft.jsch.Channel.SSH_MSG_CHANNEL_OPEN_CONFIRMATION = 91 [static, package, inherited]

Definition at line 51 of file Channel.java.

final int com.jcraft.jsch.Channel.SSH_MSG_CHANNEL_OPEN_FAILURE = 92 [static, package, inherited]

Definition at line 52 of file Channel.java.

final int com.jcraft.jsch.Channel.SSH_MSG_CHANNEL_WINDOW_ADJUST = 93 [static, package, inherited]

Definition at line 53 of file Channel.java.

final int com.jcraft.jsch.Channel.SSH_OPEN_ADMINISTRATIVELY_PROHIBITED = 1 [static, package, inherited]

Definition at line 55 of file Channel.java.

Referenced by com.jcraft.jsch.ChannelX11.run(), and com.jcraft.jsch.ChannelForwardedTCPIP.run().

final int com.jcraft.jsch.Channel.SSH_OPEN_CONNECT_FAILED = 2 [static, package, inherited]

Definition at line 56 of file Channel.java.

final int com.jcraft.jsch.Channel.SSH_OPEN_RESOURCE_SHORTAGE = 4 [static, package, inherited]

Definition at line 58 of file Channel.java.

final int com.jcraft.jsch.Channel.SSH_OPEN_UNKNOWN_CHANNEL_TYPE = 3 [static, package, inherited]

Definition at line 57 of file Channel.java.

Thread com.jcraft.jsch.Channel.thread = null [package, inherited]

Definition at line 133 of file Channel.java.

Referenced by com.jcraft.jsch.ChannelDirectTCPIP.connect(), com.jcraft.jsch.ChannelX11.run(), com.jcraft.jsch.ChannelSession.run(), com.jcraft.jsch.ChannelForwardedTCPIP.run(), com.jcraft.jsch.ChannelDirectTCPIP.run(), com.jcraft.jsch.ChannelSubsystem.start(), com.jcraft.jsch.ChannelShell.start(), com.jcraft.jsch.ChannelExec.start(), and com.jcraft.jsch.ChannelX11.write().

byte [] com.jcraft.jsch.Channel.type = Util.str2byte("foo") [protected, inherited]

Definition at line 124 of file Channel.java.

Referenced by com.jcraft.jsch.ChannelAgentForwarding.ChannelAgentForwarding(), com.jcraft.jsch.ChannelSession.ChannelSession(), and com.jcraft.jsch.ChannelX11.ChannelX11().

The documentation for this class was generated from the following file:
Generated on 5 May 2015 for HPCVIEWER by  doxygen 1.6.1