ikr.simlib.entities.queues

Class QueuingEntity

java.lang.Object

ikr.simlib.entities.Entity

ikr.simlib.entities.queues.QueuingEntity

All Implemented Interfaces:

ReflectionConstructable, ReflectionConstructable2<SimNode,Parameters>

Direct Known Subclasses:

BoundedFIFOQueue, BoundedLIFOQueue, UnboundedFIFOQueue, UnboundedLIFOQueue

public class QueuingEntity
extends Entity
implements ReflectionConstructable2<SimNode,Parameters>

QueuingEntity is the entity that integrates a queuing discipline managing some buffer into the simulation. The QueuingEntity has ports and only calls few public methods of QueuingDiscipline:

• isEmpty()
• dequeue()
• handleMessage()
• potentially dropScheduledNext() The handleMessage() may just add the message to the StackableQueuingDiscipline's data buffer or result in packet discards, maybe of the provided packet or other packet(s) already in the buffer.

Nested Class Summary

Nested classes/interfaces inherited from class ikr.simlib.entities.Entity

Entity.PortAlias

Field Summary

Fields

Modifier and Type	Field and Description
protected InputPort	inputPort
protected OutputPort	outputPort
protected QueuingDiscipline	qdisc

Fields inherited from class ikr.simlib.entities.Entity

portAliases, ports, simNode

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

CREATE_INSTANCE_METHOD_NAME

Constructor Summary

Constructors

Constructor and Description
QueuingEntity(SimNode ownNode) When using this constructor, you MUST use setQDisc to set the QueuingDiscipline before using this QueuingEntity.
QueuingEntity(SimNode ownNode, Parameters pars)

Method Summary

Methods

Modifier and Type	Method and Description
static QueuingEntity	createInstance(SimNode ownNode, Parameters pars) as required by ReflectionConstructable
InputPort	getInput()
OutputPort	getOutput()
QueuingDiscipline	getQDisc()
protected Message	handleGetMessage(Port port)
protected boolean	handleIsMessageAvailable(Port port)
protected void	handleMessageIndication(Message msg)
void	setQDisc(QueuingDiscipline queuingDisc)

Methods inherited from class ikr.simlib.entities.Entity

addPort, aliasPort, aliasPort, connect, disconnect, getName, getNode, getPortByName, getPorts, isPortKnown, unaliasPort

Methods inherited from class java.lang.Object

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

Field Detail

inputPort

protected final InputPort inputPort

outputPort

protected final OutputPort outputPort

qdisc

protected QueuingDiscipline qdisc

Constructor Detail

QueuingEntity

public QueuingEntity(SimNode ownNode,
             Parameters pars)

QueuingEntity

public QueuingEntity(SimNode ownNode)

When using this constructor, you MUST use setQDisc to set the QueuingDiscipline before using this QueuingEntity. It is expected, but not enforced, that the QueuingEntity instance is the parent SimNode of the QueuingDiscipline.

Method Detail

createInstance

public static QueuingEntity createInstance(SimNode ownNode,
                           Parameters pars)

as required by ReflectionConstructable

setQDisc

public void setQDisc(QueuingDiscipline queuingDisc)

getInput

public InputPort getInput()

getOutput

public OutputPort getOutput()

getQDisc

public QueuingDiscipline getQDisc()

handleGetMessage

protected Message handleGetMessage(Port port)

handleIsMessageAvailable

protected boolean handleIsMessageAvailable(Port port)

handleMessageIndication

protected void handleMessageIndication(Message msg)