com.subgraph.orchid

Interface Circuit

All Known Subinterfaces:

DirectoryCircuit, ExitCircuit, HiddenServiceCircuit, InternalCircuit

All Known Implementing Classes:

CircuitImpl, DirectoryCircuitImpl, ExitCircuitImpl, InternalCircuitImpl

public interface Circuit

A Circuit represents a logical path through multiple ORs. Circuits are described in section 5 of tor-spec.txt.

Method Summary

Modifier and Type	Method and Description
void	appendNode(CircuitNode node)
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	deliverControlCell(Cell cell)
void	deliverRelayCell(Cell cell)
void	destroyCircuit()
List<Stream>	getActiveStreams()
int	getCircuitId() Returns the curcuit id value for this circuit.
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()
RelayCell	receiveRelayCell() Returns the next relay response cell received on this circuit.
void	sendRelayCell(RelayCell cell) Encrypt and deliver the relay cell cell.

Method Detail

isConnected

boolean isConnected()

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

Returns:

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

isPending

boolean isPending()

isClean

boolean isClean()

isMarkedForClose

boolean isMarkedForClose()

getSecondsDirty

int getSecondsDirty()

getConnection

Connection getConnection()

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

Returns:

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

Throws:

TorException - If this circuit is not currently connected.

getCircuitId

int getCircuitId()

Returns the curcuit id value for this circuit.

Returns:

The circuit id value for this circuit.

createRelayCell

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. The returned RelayCell can then be used to populate the payload of the cell before delivering it.

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

RelayCell receiveRelayCell()

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

Returns:

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

sendRelayCell

void sendRelayCell(RelayCell cell)

Encrypt and deliver the relay cell cell.

Parameters:

cell - The relay cell to deliver over this circuit.

getFinalCircuitNode

CircuitNode getFinalCircuitNode()

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

Returns:

The final 'hop' or node of this circuit.

destroyCircuit

void destroyCircuit()

deliverRelayCell

void deliverRelayCell(Cell cell)

deliverControlCell

void deliverControlCell(Cell cell)

getActiveStreams

List<Stream> getActiveStreams()

markForClose

void markForClose()

appendNode

void appendNode(CircuitNode node)