ikr.simlib.algorithms.queuingDisciplines

Class StackableQueuingDiscipline

java.lang.Object

ikr.simlib.algorithms.queuingDisciplines.StackableQueuingDiscipline

All Implemented Interfaces:

QueuingDiscipline, ReflectionConstructable, ReflectionConstructable2<SimNode,Parameters>

Direct Known Subclasses:

FairQueuing, FIFOQDisc, LIFOQDisc

public abstract class StackableQueuingDiscipline
extends java.lang.Object
implements QueuingDiscipline

Nested Class Summary

Nested classes/interfaces inherited from interface ikr.simlib.algorithms.queuingDisciplines.QueuingDiscipline

QueuingDiscipline.QueueEntry

Field Summary

Fields

Modifier and Type	Field and Description
protected ProbabilityStatistic	lossProbability
protected IntegralStatistic	numberOfMessages
protected IntegralStatistic	numberOfUnits
protected SimNode	parent
protected SimNode	simNode
protected SampleStatistic	transferTime
protected SampleStatistic	waitingTime

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

CREATE_INSTANCE_METHOD_NAME

Constructor Summary

Constructors

Constructor and Description
StackableQueuingDiscipline(SimNode ownNode)
StackableQueuingDiscipline(SimNode ownNode, Parameters pars)

Method Summary

Methods

Modifier and Type	Method and Description
QueuingDiscipline.QueueEntry	dequeue() Dequeue the next QueuingDiscipline.QueueEntry according to the QueuingDiscipline.
QueuingDiscipline.QueueEntry	dropScheduledNext() This method returns the QueuingDiscipline.QueueEntry that would be delivered next, but accounts it as drop.
void	enqueue(Message msg)
int	getCurrentNumberOfMessages()
long	getCurrentNumberOfUnits()
abstract int	getMaxSizeInUnits()
java.lang.String	getName()
SimNode	getNode()
SimNode	getParent()
protected void	handleLossMessage(QueuingDiscipline.QueueEntry qe)
protected void	handleLossMessageInternal(QueuingDiscipline.QueueEntry qe) This method is intended to be overriden to implement any desired loss handling while ensuring that numberOfMessages and -Units is decremented accordingly.
boolean	handleMessage(Message msg) Request the QueuingDiscipline to handle the Message.
protected void	handleRejectedMessage(QueuingDiscipline.QueueEntry qe) Whatever to be done at rejected packets, e.g.
boolean	hasSpaceFor(Message msg) A simple method to check for "physical" space.
abstract boolean	isEmpty()
QueuingDiscipline.QueueEntry	peek() Retrieve the QueueEntry that would be delivered next, without actually removing it.
protected abstract QueuingDiscipline.QueueEntry	peekInternal()
protected abstract QueuingDiscipline.QueueEntry	pop() Retrieve and remove the next QueueEntry according to the queuing discipline.
protected abstract void	push(QueuingDiscipline.QueueEntry qe) Push message into the data structure managed by the queuing discipline.
protected void	statsUpdateDequeue(QueuingDiscipline.QueueEntry qe)
protected void	statsUpdateEnqueue(QueuingDiscipline.QueueEntry qe) Whatever to be done at enqueue, e.g.
protected void	statsUpdateLoss(QueuingDiscipline.QueueEntry qe) Whatever to be done on loss, e.g.
protected void	statsUpdateReject(QueuingDiscipline.QueueEntry qe)
boolean	wouldStore(Message msg)

Methods inherited from class java.lang.Object

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

Field Detail

simNode

protected final SimNode simNode

parent

protected final SimNode parent

waitingTime

protected final SampleStatistic waitingTime

transferTime

protected final SampleStatistic transferTime

numberOfUnits

protected final IntegralStatistic numberOfUnits

lossProbability

protected final ProbabilityStatistic lossProbability

numberOfMessages

protected final IntegralStatistic numberOfMessages

Constructor Detail

StackableQueuingDiscipline

public StackableQueuingDiscipline(SimNode ownNode,
                          Parameters pars)

StackableQueuingDiscipline

public StackableQueuingDiscipline(SimNode ownNode)

Method Detail

getMaxSizeInUnits

public abstract int getMaxSizeInUnits()

Specified by:

getMaxSizeInUnits in interface QueuingDiscipline

Returns:

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

getName

public java.lang.String getName()

Specified by:

getName in interface QueuingDiscipline

getNode

public SimNode getNode()

Specified by:

getNode in interface QueuingDiscipline

getParent

public SimNode getParent()

Specified by:

getParent in interface QueuingDiscipline

isEmpty

public abstract boolean isEmpty()

Specified by:

isEmpty in interface QueuingDiscipline

wouldStore

public boolean wouldStore(Message msg)

Specified by:

wouldStore in interface QueuingDiscipline

Returns:

true if the queue would store the given message. May return false due to a bounded buffer size or a probabilistic decision, for ProbabilisticQueuingDisciplines. For these, two subsequent calls with the same message may return different results!

hasSpaceFor

public boolean hasSpaceFor(Message msg)

A simple method to check for "physical" space. Therefore, in contrast to wouldStore() this method is deterministic and two subsequent calls will return the same result.
Any override implementation should be independent of the actual message itself, but just depend from msg.getLength().

Parameters:

msg -

Returns:

true if the QueuingDiscipline has space for that message.

getCurrentNumberOfMessages

public final int getCurrentNumberOfMessages()

Specified by:

getCurrentNumberOfMessages in interface QueuingDiscipline

getCurrentNumberOfUnits

public final long getCurrentNumberOfUnits()

Specified by:

getCurrentNumberOfUnits in interface QueuingDiscipline

dequeue

public final QueuingDiscipline.QueueEntry dequeue()

Description copied from interface: QueuingDiscipline

Dequeue the next QueuingDiscipline.QueueEntry according to the QueuingDiscipline. This will be accounted for as successful forwarding.

Specified by:

dequeue in interface QueuingDiscipline

Returns:

The QueuingDiscipline.QueueEntry

handleMessage

public boolean handleMessage(Message msg)

Description copied from interface: QueuingDiscipline

Request the QueuingDiscipline to handle the Message. This can either store it, then it returns true, or drop it, then it return false. If it drops it, this drop will be accounted for (as drop with 0 waiting time).

Specified by:

handleMessage in interface QueuingDiscipline

Returns:

if it has accepted the message.

dropScheduledNext

public QueuingDiscipline.QueueEntry dropScheduledNext()

Description copied from interface: QueuingDiscipline

This method returns the QueuingDiscipline.QueueEntry that would be delivered next, but accounts it as drop.

Specified by:

dropScheduledNext in interface QueuingDiscipline

Returns:

The dropped QueuingDiscipline.QueueEntry

enqueue

public final void enqueue(Message msg)

handleRejectedMessage

protected void handleRejectedMessage(QueuingDiscipline.QueueEntry qe)

Whatever to be done at rejected packets, e.g. update the statistics.

Parameters:

qe -

handleLossMessage

protected final void handleLossMessage(QueuingDiscipline.QueueEntry qe)

handleLossMessageInternal

protected void handleLossMessageInternal(QueuingDiscipline.QueueEntry qe)

This method is intended to be overriden to implement any desired loss handling while ensuring that numberOfMessages and -Units is decremented accordingly.

Parameters:

qe -

statsUpdateEnqueue

protected void statsUpdateEnqueue(QueuingDiscipline.QueueEntry qe)

Whatever to be done at enqueue, e.g. update the statistics.

Parameters:

qe -

statsUpdateReject

protected void statsUpdateReject(QueuingDiscipline.QueueEntry qe)

statsUpdateLoss

protected void statsUpdateLoss(QueuingDiscipline.QueueEntry qe)

Whatever to be done on loss, e.g. update the statistics.

Parameters:

qe -

statsUpdateDequeue

protected void statsUpdateDequeue(QueuingDiscipline.QueueEntry qe)

push

protected abstract void push(QueuingDiscipline.QueueEntry qe)

Push message into the data structure managed by the queuing discipline.

peek

public final QueuingDiscipline.QueueEntry peek()

Retrieve the QueueEntry that would be delivered next, without actually removing it. This is trivial for enqueue-/tail-dropping queues, but not for dequeue-/head-dropping queues such as CoDel. Anyway, this method MUST return the same Message object than the next pop(). Therefore only peekInternal() may be overriden.

peekInternal

protected abstract QueuingDiscipline.QueueEntry peekInternal()

pop

protected abstract QueuingDiscipline.QueueEntry pop()

Retrieve and remove the next QueueEntry according to the queuing discipline.

Returns:

the QueueEntry