com.subgraph.orchid

Interface ExitCircuit

All Superinterfaces:

Circuit

All Known Implementing Classes:

ExitCircuitImpl

public interface ExitCircuit
extends Circuit

Method Summary

Modifier and Type	Method and Description
boolean	canHandleExitTo(ExitTarget target) Return true if the final node of this circuit is believed to be able to connect to the specified ExitTarget.
boolean	canHandleExitToPort(int port)
Stream	openExitStream(IPv4Address address, int port, long timeout) Open an exit stream from the final node in this circuit to the specified target address and port.
Stream	openExitStream(String hostname, int port, long timeout) Open an exit stream from the final node in this circuit to the specified target hostname and port.
void	recordFailedExitTarget(ExitTarget target) Records the specified ExitTarget as a failed connection so that canHandleExitTo(ExitTarget) will no longer return true for this exit destination.

Methods inherited from interface com.subgraph.orchid.Circuit

appendNode, createRelayCell, deliverControlCell, deliverRelayCell, destroyCircuit, getActiveStreams, getCircuitId, getConnection, getFinalCircuitNode, getSecondsDirty, isClean, isConnected, isMarkedForClose, isPending, markForClose, receiveRelayCell, sendRelayCell

Method Detail

openExitStream

Stream openExitStream(IPv4Address address,
                      int port,
                      long timeout)
               throws InterruptedException,
                      TimeoutException,
                      StreamConnectFailedException

Open an exit stream from the final node in this circuit to the specified target address and port.

Parameters:

address - The network address of the exit target.

port - The port of the exit target.

Returns:

The status response returned by trying to open the stream.

Throws:

InterruptedException

TimeoutException

StreamConnectFailedException

openExitStream

Stream openExitStream(String hostname,
                      int port,
                      long timeout)
               throws InterruptedException,
                      TimeoutException,
                      StreamConnectFailedException

Open an exit stream from the final node in this circuit to the specified target hostname and port.

Parameters:

hostname - The network hostname of the exit target.

port - The port of the exit target.

Returns:

The status response returned by trying to open the stream.

Throws:

InterruptedException

TimeoutException

StreamConnectFailedException

canHandleExitTo

boolean canHandleExitTo(ExitTarget target)

Return true if the final node of this circuit is believed to be able to connect to the specified ExitTarget. Returns false if the target destination is not permitted by the exit policy of the final node in this circuit or if the target has been previously recorded to have failed through this circuit.

Parameters:

target - The exit destination.

Returns:

Return true if is likely that the final node of this circuit can connect to the specified exit target.

canHandleExitToPort

boolean canHandleExitToPort(int port)

recordFailedExitTarget

void recordFailedExitTarget(ExitTarget target)

Records the specified ExitTarget as a failed connection so that canHandleExitTo(ExitTarget) will no longer return true for this exit destination.

Parameters:

target - The ExitTarget to which a connection has failed through this circuit.