Package marauroa.client.net

Class TCPNetworkClientManager

java.lang.Object

marauroa.client.net.TCPNetworkClientManager

All Implemented Interfaces:

INetworkClientManagerInterface

public final class TCPNetworkClientManager
extends Object
implements INetworkClientManagerInterface

This is the basic implementation of a TCP network manager.

Author:

hendrik

Field Summary

Fields

Modifier and Type	Field	Description
protected static boolean	registered	already registered?

Constructor Summary

Constructors

Constructor	Description
TCPNetworkClientManager(String host, int port)	Constructor that opens the socket on the marauroa_PORT and start the thread to receive new messages from the network.
TCPNetworkClientManager(Proxy proxy, InetSocketAddress serverAddress)	Constructor that opens the socket on the marauroa_PORT and start the thread to receive new messages from the network.

Method Summary

Modifier and Type	Method	Description
void	addMessage(Message msg)	This method add a message to be delivered to the client the message is pointed to.
void	finish()	This method notify the thread to finish it execution
InetSocketAddress	getAddress()	Returns the ip address and port-number
boolean	getConnectionState()	Returns true if the connection is "connected" to server or false otherwise.
Message	getMessage(int timeout)	This method returns a Message from the list or block for timeout milliseconds until a message is available or null if timeout happens.
Collection<Message>	getMessages()	Deprecated.
void	retrieveMessages(Collection<? super Message> drainTo)	gets all messages received so far and removes them from the queue.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

registered

protected static boolean registered

already registered?

Constructor Details

TCPNetworkClientManager

public TCPNetworkClientManager(String host,
 int port)
                        throws IOException

Constructor that opens the socket on the marauroa_PORT and start the thread to receive new messages from the network.

Parameters:

host - the host where we connect to.

port - the port of the server where we connect to.

Throws:

IOException

TCPNetworkClientManager

public TCPNetworkClientManager(Proxy proxy,
 InetSocketAddress serverAddress)
                        throws IOException

Constructor that opens the socket on the marauroa_PORT and start the thread to receive new messages from the network.

Parameters:

proxy - proxy server and protocol to use

serverAddress - the host and port where we connect to.

Throws:

IOException

Method Details

finish

public void finish()

Description copied from interface: INetworkClientManagerInterface

This method notify the thread to finish it execution

Specified by:

finish in interface INetworkClientManagerInterface

getAddress

public InetSocketAddress getAddress()

Description copied from interface: INetworkClientManagerInterface

Returns the ip address and port-number

Specified by:

getAddress in interface INetworkClientManagerInterface

Returns:

InetSocketAddress

getMessage

public Message getMessage(int timeout)
                   throws InvalidVersionException

Description copied from interface: INetworkClientManagerInterface

This method returns a Message from the list or block for timeout milliseconds until a message is available or null if timeout happens.

Specified by:

getMessage in interface INetworkClientManagerInterface

Parameters:

timeout - timeout time in milliseconds

Returns:

a Message or null if timeout happens

Throws:

InvalidVersionException

retrieveMessages

public void retrieveMessages(Collection<? super Message> drainTo)

gets all messages received so far and removes them from the queue.

Parameters:

drainTo - the messages received

getMessages

@Deprecated
public Collection<Message> getMessages()

Deprecated.

gets all messages received so far and removes them from the queue.

Returns:

the messages received

addMessage

public void addMessage(Message msg)

Description copied from interface: INetworkClientManagerInterface

This method add a message to be delivered to the client the message is pointed to.

Specified by:

addMessage in interface INetworkClientManagerInterface

Parameters:

msg - the message to be delivered.

getConnectionState

public boolean getConnectionState()

Returns true if the connection is "connected" to server or false otherwise.

Specified by:

getConnectionState in interface INetworkClientManagerInterface

Returns:

true if socket is connected.