com.subgraph.orchid

Interface CircuitBuildHandler

All Known Implementing Classes:

CircuitCreationRequest

public interface CircuitBuildHandler

This callback interface is used for reporting progress when opening a new circuit. An instance of this interface is passed to the Circuit#openCircuit(java.util.List, CircuitBuildHandler) method. The normal sequence of callbacks which are fired when a circuit is opened successfully is connectionCompleted(Connection) for the initial connection to the entry router, followed by one or more nodeAdded(CircuitNode) as the circuit is extended with new nodes. When all requested nodes in the path have been added successfully to the circuit circuitBuildCompleted(Circuit) is called and passed the newly constructed circuit.

See Also:

Circuit#openCircuit()

Method Summary

Modifier and Type	Method and Description
void	circuitBuildCompleted(Circuit circuit) The circuit has been successfully built and is ready for use.
void	circuitBuildFailed(String reason) Called if the circuit build fails after connecting to the entry node.
void	connectionCompleted(Connection connection) Called when a network connection to the entry node has completed successfully or if a network connection to the specified entry router already exists.
void	connectionFailed(String reason) The circuit build has failed because the network connection to the entry node failed.
void	nodeAdded(CircuitNode node) A node or 'hop' has been added to the circuit which is being created.

Method Detail

connectionCompleted

void connectionCompleted(Connection connection)

Called when a network connection to the entry node has completed successfully or if a network connection to the specified entry router already exists.

Parameters:

connection - The completed connection instance.

connectionFailed

void connectionFailed(String reason)

The circuit build has failed because the network connection to the entry node failed. No further callback methods will be called after this failure has been reported.

Parameters:

reason - A description of the reason for failing to connect to the entry node.

nodeAdded

void nodeAdded(CircuitNode node)

A node or 'hop' has been added to the circuit which is being created.

Parameters:

node - The newly added circuit node.

circuitBuildCompleted

void circuitBuildCompleted(Circuit circuit)

The circuit has been successfully built and is ready for use.

Parameters:

circuit - The newly constructed circuit.

circuitBuildFailed

void circuitBuildFailed(String reason)

Called if the circuit build fails after connecting to the entry node.

Parameters:

reason - A description of the reason the circuit build has failed.