com.subgraph.orchid.circuits

Class StreamImpl

java.lang.Object

com.subgraph.orchid.circuits.StreamImpl

All Implemented Interfaces:

DashboardRenderable, Stream

public class StreamImpl
extends Object
implements Stream, DashboardRenderable

Field Summary

Fields inherited from interface com.subgraph.orchid.dashboard.DashboardRenderable

DASHBOARD_CIRCUITS, DASHBOARD_CONNECTIONS, DASHBOARD_CONNECTIONS_VERBOSE, DASHBOARD_PREDICTED_PORTS, DASHBOARD_STREAMS

Method Summary

Modifier and Type	Method and Description
void	close() Close this stream.
void	dashboardRender(DashboardRenderer renderer, PrintWriter writer, int flags)
Circuit	getCircuit() Returns the Circuit this stream belongs to.
InputStream	getInputStream() Returns an InputStream for sending data on this stream.
OutputStream	getOutputStream() Returns an OutputStream for receiving data from this stream.
int	getStreamId() Returns the stream id value of this stream.
CircuitNode	getTargetNode()
void	openDirectory(long timeout)
String	toString()
void	waitForSendWindow() If the circuit and stream level packaging windows are open for this stream this method returns immediately, otherwise it blocks until both windows are open or the stream is closed.
void	waitForSendWindow(boolean decrement)
void	waitForSendWindowAndDecrement()

Methods inherited from class java.lang.Object

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

Method Detail

getStreamId

public int getStreamId()

Description copied from interface: Stream

Returns the stream id value of this stream.

Specified by:

getStreamId in interface Stream

Returns:

The stream id value of this stream.

getCircuit

public Circuit getCircuit()

Description copied from interface: Stream

Returns the Circuit this stream belongs to.

Specified by:

getCircuit in interface Stream

Returns:

The Circuit this stream belongs to.

getTargetNode

public CircuitNode getTargetNode()

Specified by:

getTargetNode in interface Stream

close

public void close()

Description copied from interface: Stream

Close this stream.

Specified by:

close in interface Stream

openDirectory

public void openDirectory(long timeout)
                   throws InterruptedException,
                          TimeoutException,
                          StreamConnectFailedException

Throws:

InterruptedException

TimeoutException

StreamConnectFailedException

getInputStream

public InputStream getInputStream()

Description copied from interface: Stream

Returns an InputStream for sending data on this stream.

Specified by:

getInputStream in interface Stream

Returns:

An InputStream for transferring data on this stream.

getOutputStream

public OutputStream getOutputStream()

Description copied from interface: Stream

Returns an OutputStream for receiving data from this stream.

Specified by:

getOutputStream in interface Stream

Returns:

An OutputStream for receiving data from this stream.

waitForSendWindowAndDecrement

public void waitForSendWindowAndDecrement()

waitForSendWindow

public void waitForSendWindow()

Description copied from interface: Stream

If the circuit and stream level packaging windows are open for this stream this method returns immediately, otherwise it blocks until both windows are open or the stream is closed.

Specified by:

waitForSendWindow in interface Stream

waitForSendWindow

public void waitForSendWindow(boolean decrement)

toString

public String toString()

Overrides:

toString in class Object

dashboardRender

public void dashboardRender(DashboardRenderer renderer,
                            PrintWriter writer,
                            int flags)
                     throws IOException

Specified by:

dashboardRender in interface DashboardRenderable

Throws:

IOException