Package com.levigo.jadice.web.transport.client.networking

Interface TransportClient

public interface TransportClient

A TransportClient is able to establish a connection with a sever in order to exchange messages. It sends messages in form of plain text and receive messages. Furthermore, TransportClient.TransportListeners can be registered in order to get notifications from transport events.

Functionalities provided by this interface are

• Getting the Method via getMethod()
• Getting the TransportClient.State via getState()
• Adding and removing TransportClient.TransportListeners via addListener(TransportListener) and removeListener(TransportListener)
• Trigger the client to connect to the server via connect()
• Trigger the client to disconnect from the server via disconnect()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	TransportClient.State	Represents the connection state of the client.
static interface	TransportClient.TransportListener	A TransportListener gets informed about client transport events.

Method Summary

Modifier and Type	Method	Description
void	addListener(TransportClient.TransportListener listener)	Adds a new TransportClient.TransportListener to the transport client.
void	connect()	Connects the client to the server.
void	disconnect()	Disconnects the client from the server.
String	getClientId()	Return the cryptographic client id of this client instance.
Method	getMethod()
TransportClient.State	getState()
void	removeListener(TransportClient.TransportListener listener)	Removes the given TransportClient.TransportListener from the list of listeners.

Method Details

getMethod

Method getMethod()

Returns:

The connection Method being used.

getState

TransportClient.State getState()

Returns:

The connection TransportClient.State of the client.

addListener

void addListener(TransportClient.TransportListener listener)

Adds a new TransportClient.TransportListener to the transport client.

Parameters:

listener - the TransportClient.TransportListener that should be registered

removeListener

void removeListener(TransportClient.TransportListener listener)

Removes the given TransportClient.TransportListener from the list of listeners.

Parameters:

listener - the TransportClient.TransportListener which should be removed

connect

void connect()
      throws IOException

Connects the client to the server.

Throws:

IOException - If the connection process failed.

disconnect

void disconnect()

Disconnects the client from the server.

getClientId

String getClientId()

Return the cryptographic client id of this client instance.

Returns:

the client id