ikr.simlib.algorithms

Interface MessageClassificator<Key,Consumer>

All Superinterfaces:

ReflectionConstructable, ReflectionConstructable2<SimNode,Parameters>

public interface MessageClassificator<Key,Consumer>
extends ReflectionConstructable2<SimNode,Parameters>

MessageClassificator is used to manage a set of handlers for aggregates of packets, i.e. flows, and their mapping to these flows. MessageClassificators are used to identify the proper sub- StackableQueuingDiscipline in hierarchical queuing disciplines. Any class implementing this interface MUST implement a constructor taking Parameters, SimNode and String as parameters to allow for dynamic configuration. Most implementations will be part of the IKR ProtocolSupport library since they are relevant for DataMessages only. A MessageClassificator never creates new Consumers.

Author:

dwagner

Field Summary

Fields inherited from interface ikr.simlib.parameters.reflection.ReflectionConstructable

CREATE_INSTANCE_METHOD_NAME

Method Summary

Methods

Modifier and Type	Method and Description
Consumer	getConsumer(Message msg) This method returns the Consumer object for the given Message according to its classification mapping.
java.util.Collection<Consumer>	getConsumers() This method returns a set if the consumers existing in / managed by this MessageClassificator.
java.util.Set<java.util.Map.Entry<Key,Consumer>>	getEntrySet() This method shall give access to the key-value pairs to allow for manipulation.
void	insertConsumer(Message msg, Consumer c) This method maps a consumer c to the flow the Message msg belongs to, according to the MessageClassificator's internal mapping algorithms.
void	removeConsumer(Message msg)

Method Detail

getConsumer

Consumer getConsumer(Message msg)

This method returns the Consumer object for the given Message according to its classification mapping. If such Consumer, e.g. a StackableQueuingDiscipline, does not exist, it returns null. It does not create new Consumers.

insertConsumer

void insertConsumer(Message msg,
                  Consumer c)

This method maps a consumer c to the flow the Message msg belongs to, according to the MessageClassificator's internal mapping algorithms. Unfortunately, Java does not allow to define derived Classes to expose methods accepting the Generic Parameter, so implementations will accept Objects here and have to cast them.

removeConsumer

void removeConsumer(Message msg)

getConsumers

java.util.Collection<Consumer> getConsumers()

This method returns a set if the consumers existing in / managed by this MessageClassificator.
BE AWARE that this may return a collection backed by the used data structure itself, so changes in the returned Collection result in changes in the MessageClassificator itself.
Its main purpose is to deliver an Iterator to access the stored consumer for tracing. Therefore, any implementation should return that Collection in the order of insertion. This is the case for LinkedHashMaps for example.

getEntrySet

java.util.Set<java.util.Map.Entry<Key,Consumer>> getEntrySet()

This method shall give access to the key-value pairs to allow for manipulation. The set is backed by the internal data structure, so changes to the map are reflected in the set, and vice-versa.