com.subgraph.orchid.circuits

Class CircuitImpl

java.lang.Object

com.subgraph.orchid.circuits.CircuitImpl

All Implemented Interfaces:

Circuit, DashboardRenderable

Direct Known Subclasses:

DirectoryCircuitImpl, ExitCircuitImpl, InternalCircuitImpl

public abstract class CircuitImpl
extends Object
implements Circuit, DashboardRenderable

This class represents an established circuit through the Tor network.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	logger
protected List<Router>	prechosenPath

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

DASHBOARD_CIRCUITS, DASHBOARD_CONNECTIONS, DASHBOARD_CONNECTIONS_VERBOSE, DASHBOARD_PREDICTED_PORTS, DASHBOARD_STREAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CircuitImpl(CircuitManagerImpl circuitManager)
protected	CircuitImpl(CircuitManagerImpl circuitManager, List<Router> prechosenPath)

Method Summary

Modifier and Type	Method and Description
void	appendNode(CircuitNode node)
protected abstract List<Router>	choosePathForCircuit(CircuitPathChooser pathChooser)
protected StreamImpl	createNewStream()
protected StreamImpl	createNewStream(boolean autoclose)
RelayCell	createRelayCell(int relayCommand, int streamId, CircuitNode targetNode) Create a new relay cell which is configured for delivery to the specified circuit targetNode with command value relayCommand and a stream id value of streamId.
void	dashboardRender(DashboardRenderer renderer, PrintWriter writer, int flags)
void	deliverControlCell(Cell cell)
void	deliverRelayCell(Cell cell)
void	destroyCircuit()
List<Stream>	getActiveStreams()
int	getCircuitId() Returns the curcuit id value for this circuit.
protected abstract String	getCircuitTypeLabel()
Connection	getConnection() Returns the entry router Connection object of this Circuit.
CircuitNode	getFinalCircuitNode() Return the last node or 'hop' in this circuit.
int	getSecondsDirty()
boolean	isClean()
boolean	isConnected() Return true if the circuit is presently in the connected state or false otherwise.
boolean	isMarkedForClose()
boolean	isPending()
void	markForClose()
protected String	pathToString()
protected Stream	processStreamOpenException(Exception e)
RelayCell	receiveRelayCell() Returns the next relay response cell received on this circuit.
void	removeStream(StreamImpl stream)
void	sendRelayCell(RelayCell cell) Encrypt and deliver the relay cell cell.
void	sendRelayCellToFinalNode(RelayCell cell)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final Logger logger

prechosenPath

protected final List<Router> prechosenPath

Constructor Detail

CircuitImpl

protected CircuitImpl(CircuitManagerImpl circuitManager)

CircuitImpl

protected CircuitImpl(CircuitManagerImpl circuitManager,
                      List<Router> prechosenPath)

Method Detail

choosePathForCircuit

protected abstract List<Router> choosePathForCircuit(CircuitPathChooser pathChooser)
                                              throws InterruptedException,
                                                     PathSelectionFailedException

Throws:

InterruptedException

PathSelectionFailedException

markForClose

public void markForClose()

Specified by:

markForClose in interface Circuit

isMarkedForClose

public boolean isMarkedForClose()

Specified by:

isMarkedForClose in interface Circuit

isConnected

public boolean isConnected()

Description copied from interface: Circuit

Return true if the circuit is presently in the connected state or false otherwise.

Specified by:

isConnected in interface Circuit

Returns:

Returns true if the circuit is presently connected, or false otherwise.

isPending

public boolean isPending()

Specified by:

isPending in interface Circuit

isClean

public boolean isClean()

Specified by:

isClean in interface Circuit

getSecondsDirty

public int getSecondsDirty()

Specified by:

getSecondsDirty in interface Circuit

getConnection

public Connection getConnection()

Description copied from interface: Circuit

Returns the entry router Connection object of this Circuit. Throws a TorException if the circuit is not currently open.

Specified by:

getConnection in interface Circuit

Returns:

The Connection object for the network connection to the entry router of this circuit.

getCircuitId

public int getCircuitId()

Description copied from interface: Circuit

Returns the curcuit id value for this circuit.

Specified by:

getCircuitId in interface Circuit

Returns:

The circuit id value for this circuit.

sendRelayCell

public void sendRelayCell(RelayCell cell)

Description copied from interface: Circuit

Encrypt and deliver the relay cell cell.

Specified by:

sendRelayCell in interface Circuit

Parameters:

cell - The relay cell to deliver over this circuit.

sendRelayCellToFinalNode

public void sendRelayCellToFinalNode(RelayCell cell)

appendNode

public void appendNode(CircuitNode node)

Specified by:

appendNode in interface Circuit

getFinalCircuitNode

public CircuitNode getFinalCircuitNode()

Description copied from interface: Circuit

Return the last node or 'hop' in this circuit.

Specified by:

getFinalCircuitNode in interface Circuit

Returns:

The final 'hop' or node of this circuit.

createRelayCell

public RelayCell createRelayCell(int relayCommand,
                                 int streamId,
                                 CircuitNode targetNode)

Description copied from interface: Circuit

Create a new relay cell which is configured for delivery to the specified circuit targetNode with command value relayCommand and a stream id value of streamId. The returned RelayCell can then be used to populate the payload of the cell before delivering it.

Specified by:

createRelayCell in interface Circuit

Parameters:

relayCommand - The command value to send in the relay cell header.

streamId - The stream id value to send in the relay cell header.

targetNode - The target circuit node to encrypt this cell for.

Returns:

A newly created relay cell object.

receiveRelayCell

public RelayCell receiveRelayCell()

Description copied from interface: Circuit

Returns the next relay response cell received on this circuit. If no response is received within CIRCUIT_RELAY_RESPONSE_TIMEOUT milliseconds, null is returned.

Specified by:

receiveRelayCell in interface Circuit

Returns:

The next relay response cell received on this circuit or null if a timeout is reached before the next relay cell arrives.

deliverControlCell

public void deliverControlCell(Cell cell)

Specified by:

deliverControlCell in interface Circuit

deliverRelayCell

public void deliverRelayCell(Cell cell)

Specified by:

deliverRelayCell in interface Circuit

createNewStream

protected StreamImpl createNewStream(boolean autoclose)

createNewStream

protected StreamImpl createNewStream()

destroyCircuit

public void destroyCircuit()

Specified by:

destroyCircuit in interface Circuit

removeStream

public void removeStream(StreamImpl stream)

processStreamOpenException

protected Stream processStreamOpenException(Exception e)
                                     throws InterruptedException,
                                            TimeoutException,
                                            StreamConnectFailedException

Throws:

InterruptedException

TimeoutException

StreamConnectFailedException

getCircuitTypeLabel

protected abstract String getCircuitTypeLabel()

toString

public String toString()

Overrides:

toString in class Object

pathToString

protected String pathToString()

getActiveStreams

public List<Stream> getActiveStreams()

Specified by:

getActiveStreams in interface Circuit

dashboardRender

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

Specified by:

dashboardRender in interface DashboardRenderable

Throws:

IOException