com.subgraph.orchid

Interface Connection

All Known Implementing Classes:

ConnectionImpl

public interface Connection

A network connection to a Tor onion router.

Method Summary

Modifier and Type	Method and Description
int	bindCircuit(Circuit circuit) Choose an available circuit id value and bind this Circuit to that id value, returning the id value.
Router	getRouter() Return the Router associated with this connection.
boolean	isClosed() Return true if the socket for this connection has been closed.
void	removeCircuit(Circuit circuit) Remove a Circuit which has been bound to this Connection by a previous call to bindCircuit.
void	sendCell(Cell cell) Send a protocol Cell on this connection.

Method Detail

getRouter

Router getRouter()

Return the Router associated with this connection.

Returns:

The entry router this connection represents.

isClosed

boolean isClosed()

Return true if the socket for this connection has been closed. Otherwise, false.

Returns:

true if this connection is closed or false otherwise.

sendCell

void sendCell(Cell cell)
       throws ConnectionIOException

Send a protocol Cell on this connection.

Parameters:

cell - The Cell to transfer.

Throws:

ConnectionIOException - If the cell could not be send because the connection is not connected or if an error occured while sending the cell data.

removeCircuit

void removeCircuit(Circuit circuit)

Remove a Circuit which has been bound to this Connection by a previous call to bindCircuit. After removing a Circuit, any further received incoming cells for the Circuit will be discarded.

Parameters:

circuit - The Circuit to remove.

bindCircuit

int bindCircuit(Circuit circuit)

Choose an available circuit id value and bind this Circuit to that id value, returning the id value. Once bound, any incoming relay cells will be delivered to the Circuit with Circuit.deliverRelayCell(Cell) and other cells will be delivered with Circuit.deliverControlCell(Cell).

Parameters:

circuit - The Circuit to bind to this connection.

Returns:

the circuit id value for this binding.