hudson.remoting.forward

Class PortForwarder

java.lang.Object

java.lang.Thread

hudson.remoting.forward.PortForwarder

All Implemented Interfaces:

ListeningPort, Closeable, AutoCloseable, Runnable

public class PortForwarder
extends Thread
implements Closeable, ListeningPort

Port forwarder over a remote channel.

Since:

1.315

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
static Role	ROLE Role that's willing to listen on a socket and forward that to the other side.

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
PortForwarder(int localPort, Forwarder forwarder)

Method Summary

Modifier and Type	Method and Description
void	close() Shuts down this port forwarder.
static ListeningPort	create(VirtualChannel ch, int acceptingPort, Forwarder forwarder) Starts a PortForwarder accepting remotely at the given channel, which connects by using the given connector.
int	getPort() TCP/IP port that is listening.
void	run()

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final Role ROLE

Role that's willing to listen on a socket and forward that to the other side.

Constructor Detail

PortForwarder

public PortForwarder(int localPort,
                     Forwarder forwarder)
              throws IOException

Throws:

IOException

Method Detail

getPort

public int getPort()

Description copied from interface: ListeningPort

TCP/IP port that is listening.

Specified by:

getPort in interface ListeningPort

run

public void run()

Specified by:

run in interface Runnable

Overrides:

run in class Thread

close

public void close()
           throws IOException

Shuts down this port forwarder.

Specified by:

close in interface ListeningPort

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

create

public static ListeningPort create(VirtualChannel ch,
                                   int acceptingPort,
                                   Forwarder forwarder)
                            throws IOException,
                                   InterruptedException

Starts a PortForwarder accepting remotely at the given channel, which connects by using the given connector.

Returns:

A Closeable that can be used to shut the port forwarding down.

Throws:

IOException

InterruptedException