at.borkowski.scovillej.services.comm

Class CommunicationServiceBuilder

java.lang.Object

at.borkowski.scovillej.services.comm.CommunicationServiceBuilder

public class CommunicationServiceBuilder
extends Object

A class facilitating the creation of communication service objects (see CommunicationService).

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_BUFFER_SIZE The default buffer size used, in bytes.

Constructor Summary

Constructors

Constructor and Description
CommunicationServiceBuilder()

Method Summary

Modifier and Type	Method and Description
CommunicationServiceBuilder	bufferSize(int bufferSize) Sets the buffer size, in bytes, used for communictation
CommunicationServiceBuilder	communicationPhase(String phase) Sets the phase during which communiction takes place.
ServiceProvider<CommunicationService>	create() Creates the communication service.
CommunicationServiceBuilder	delay(String socketName, Long delay) Adds a delay to the given socket, both uplink and downlink.
CommunicationServiceBuilder	delay(String socketName, Long updelay, Long downdelay) Adds a delay to the given socket.
CommunicationServiceBuilder	limit(String socketName, Integer rate) Limits the given socket name to the given byte rates, both uplink and downlink.
CommunicationServiceBuilder	limit(String socketName, Integer uplinkRate, Integer downlinkRate) Limits the given socket name to the given uplink and downlink byte rates.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BUFFER_SIZE

public static final int DEFAULT_BUFFER_SIZE

The default buffer size used, in bytes.

See Also:

Constant Field Values

Constructor Detail

CommunicationServiceBuilder

public CommunicationServiceBuilder()

Method Detail

communicationPhase

public CommunicationServiceBuilder communicationPhase(String phase)

Sets the phase during which communiction takes place. The default is the main tick phase (see Simulation.TICK_PHASE.

Parameters:

phase - the communiction phase

Returns:

this object

limit

public CommunicationServiceBuilder limit(String socketName,
                                         Integer uplinkRate,
                                         Integer downlinkRate)

Limits the given socket name to the given uplink and downlink byte rates.

Parameters:

socketName - the name of the socket to limit

uplinkRate - the uplink (client to server) byte rate per tick

downlinkRate - the downlink (server to client) byte rate per tick

Returns:

this object

limit

public CommunicationServiceBuilder limit(String socketName,
                                         Integer rate)

Limits the given socket name to the given byte rates, both uplink and downlink.

Parameters:

socketName - the name of the socket to limit

rate - the rate to set

Returns:

this object

delay

public CommunicationServiceBuilder delay(String socketName,
                                         Long updelay,
                                         Long downdelay)

Adds a delay to the given socket.

Parameters:

socketName - the name of the socket to add delay to

updelay - the uplink (client to server) delay in ticks

downdelay - the downlink (server to client) delay in ticks

Returns:

delay

public CommunicationServiceBuilder delay(String socketName,
                                         Long delay)

Adds a delay to the given socket, both uplink and downlink.

Parameters:

socketName - the name of the socket to add delay to

delay - the delay in ticks to set

Returns:

this object

bufferSize

public CommunicationServiceBuilder bufferSize(int bufferSize)

Sets the buffer size, in bytes, used for communictation

Parameters:

bufferSize - the buffer size

Returns:

this object

create

public ServiceProvider<CommunicationService> create()

Creates the communication service.

Returns:

the communication service