at.borkowski.scovillej.services.comm

Interface CommunicationService

All Known Implementing Classes:

CommunicationServiceImpl

public interface CommunicationService

Provides socket-(name-)base communication to simulation members.

Method Summary

Modifier and Type	Method and Description
<T> void	addSerializer(Class<T> clazz, Serializer<T> serializer) Adds a data type serializer used for socket connections.
<T> SimulationSocket<T>	beginConnect(String name, Class<T> clazz) Creates a client socket and begins connection to the given socket name, using the given object class for transfer.
<T> SimulationServerSocket<T>	createServerSocket(String name, Class<T> clazz) Creates a server socket listening under the given name for connections, being able to transfer objects of the given class.
Integer	getDownlinkRate(String name) Returns the current downlink byte rate for the given socket.
Integer	getUplinkRate(String name) Returns the current uplink byte rate for the given socket.
void	setRates(String name, Integer uplink, Integer downlink) Sets the upink/downlink byte rates for the given socket.

Method Detail

createServerSocket

<T> SimulationServerSocket<T> createServerSocket(String name,
                                                 Class<T> clazz)
                                          throws IOException

Creates a server socket listening under the given name for connections, being able to transfer objects of the given class.

Parameters:

name - the socket name

clazz - the class transferred over the socket

Returns:

the server socket

Throws:

IOException - if the name is already in use

beginConnect

<T> SimulationSocket<T> beginConnect(String name,
                                     Class<T> clazz)
                              throws IOException

Creates a client socket and begins connection to the given socket name, using the given object class for transfer.

Parameters:

name - the socket name to connect to

clazz - the class transferred over the socket

Returns:

the client socket

Throws:

IOException - if the name is not in use or the server socket uses an incompatible data type

setRates

void setRates(String name,
              Integer uplink,
              Integer downlink)

Sets the upink/downlink byte rates for the given socket. All present and future connections with the given socket name will use these rates.

Parameters:

name - the name of the socket to set rates

uplink - the uplink rate in bytes per tick

downlink - the downlink rate in bytes per tick

addSerializer

<T> void addSerializer(Class<T> clazz,
                       Serializer<T> serializer)

Adds a data type serializer used for socket connections.

Parameters:

clazz - the class to serialize

serializer - the serializer to use

getUplinkRate

Integer getUplinkRate(String name)

Returns the current uplink byte rate for the given socket.

Parameters:

name - the socket name

Returns:

the uplink byte rate, or null if unlimited

getDownlinkRate

Integer getDownlinkRate(String name)

Returns the current downlink byte rate for the given socket.

Parameters:

name - the socket name

Returns:

the downlink byte rate, or null if unlimited