ikr.simlib.entities.queues

Class Queue

java.lang.Object

ikr.simlib.entities.Entity

ikr.simlib.entities.queues.Queue

Direct Known Subclasses:

FIFOQueue, LIFOQueue

public abstract class Queue
extends Entity

Queue is an abstract base class that defines some methods that must be overridden in derived classes to define different queue types. If the protocol is properly followed, the statistics are gathered automatically by the base class.
Statistics distinguish between messages and units (length field in messages)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Queue.QueueEntry

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

Entity.PortAlias

Field Summary

Fields

Modifier and Type	Field and Description
protected long	currentNumberOfUnits actual size of the queue in units "size in messages" in kept in the list
protected InputPort	inputPort
protected ProbabilityStatistic	lossProbability
protected IntegralStatistic	numberOfMessages length in Messages
protected IntegralStatistic	numberOfUnits length in (length) units
protected OutputPort	outputPort
protected SampleStatistic	transferTime
protected SampleStatistic	waitingTime

Fields inherited from class ikr.simlib.entities.Entity

portAliases, ports, simNode

Constructor Summary

Constructors

Constructor and Description
Queue(java.lang.String name, SimNode parentNode)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract Queue.QueueEntry	get()
abstract int	getCurrentNumberOfMessages()
abstract long	getCurrentNumberOfUnits()
InputPort	getInput()
abstract int	getMaxSizeInUnits()
OutputPort	getOutput()
protected Message	handleGetMessage(Port port)
protected boolean	handleIsMessageAvailable(Port port)
protected void	handleLossMessage(Queue.QueueEntry qe)
protected void	handleMessageIndication(Message msg)
abstract boolean	isEmpty()
abstract boolean	isFull(Message msg)
protected abstract void	put(Queue.QueueEntry qe)

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

currentNumberOfUnits

protected long currentNumberOfUnits

actual size of the queue in units "size in messages" in kept in the list

inputPort

protected final InputPort inputPort

outputPort

protected final OutputPort outputPort

waitingTime

protected final SampleStatistic waitingTime

transferTime

protected final SampleStatistic transferTime

numberOfMessages

protected final IntegralStatistic numberOfMessages

length in Messages

numberOfUnits

protected final IntegralStatistic numberOfUnits

length in (length) units

lossProbability

protected final ProbabilityStatistic lossProbability

Constructor Detail

Queue

public Queue(java.lang.String name,
     SimNode parentNode)

Method Detail

getInput

public InputPort getInput()

getOutput

public OutputPort getOutput()

put

protected abstract void put(Queue.QueueEntry qe)

get

protected abstract Queue.QueueEntry get()

handleLossMessage

protected void handleLossMessage(Queue.QueueEntry qe)

isEmpty

public abstract boolean isEmpty()

isFull

public abstract boolean isFull(Message msg)

Returns:

true if the queue cannot store the given message due to its bounded buffer size.

getCurrentNumberOfMessages

public abstract int getCurrentNumberOfMessages()

getCurrentNumberOfUnits

public abstract long getCurrentNumberOfUnits()

getMaxSizeInUnits

public abstract int getMaxSizeInUnits()

Returns:

maximum size of queue or Integer.MAX_VALUE if queue is unbounded.

handleGetMessage

protected Message handleGetMessage(Port port)

handleIsMessageAvailable

protected boolean handleIsMessageAvailable(Port port)

handleMessageIndication

protected void handleMessageIndication(Message msg)