Package pt.unl.fct.di.novasys.babel.core

Class GenericProtocol

java.lang.Object

pt.unl.fct.di.novasys.babel.core.GenericProtocol

Direct Known Subclasses:

PhiTest.PhiProto, TimerProto

public abstract class GenericProtocol
extends Object

An abstract class that represent a generic protocol

This class handles all interactions required by protocols

Users should extend this class to implement their protocols

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GenericProtocol.ProtocolMetrics

Constructor Summary

Constructors

Constructor	Description
GenericProtocol(String protoName, short protoId)	Create a generic protocol with the provided name and numeric identifier and network service
GenericProtocol(String protoName, short protoId, BlockingQueue<InternalEvent> policy)	Creates a generic protocol with the provided name and numeric identifier and the given event queue policy.

Method Summary

Modifier and Type	Method	Description
GenericProtocol.ProtocolMetrics	getMetrics()
final short	getProtoId()	Returns the numeric identifier of the protocol
final String	getProtoName()	Returns the name of the protocol
abstract void	init(Properties props)	Initializes the protocol with the given properties
final void	start()	Start the execution thread of the protocol

Methods inherited from class java.lang.Object

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

Constructor Details

GenericProtocol

public GenericProtocol(String protoName,
 short protoId,
 BlockingQueue<InternalEvent> policy)

Creates a generic protocol with the provided name and numeric identifier and the given event queue policy.

Event queue policies can be defined to specify handling events in desired orders: Eg. If multiple events are inside the queue, then timers are always processes first than any other event in the queue.

Parameters:

protoName - the protocol name

protoId - the protocol numeric identifier

policy - the queue policy to use

GenericProtocol

public GenericProtocol(String protoName,
 short protoId)

Create a generic protocol with the provided name and numeric identifier and network service

The internal event queue is defined to have a FIFO policy on all events

Parameters:

protoName - name of the protocol

protoId - numeric identifier

Method Details

getProtoId

public final short getProtoId()

Returns the numeric identifier of the protocol

Returns:

numeric identifier

getProtoName

public final String getProtoName()

Returns the name of the protocol

Returns:

name

init

public abstract void init(Properties props)
                   throws HandlerRegistrationException,
IOException

Initializes the protocol with the given properties

Parameters:

props - properties

Throws:

HandlerRegistrationException

IOException

start

public final void start()

Start the execution thread of the protocol

getMetrics

public GenericProtocol.ProtocolMetrics getMetrics()