ikr.simlib.algorithms.queuingDisciplines

Interface QueuingDiscipline

All Superinterfaces:

ReflectionConstructable, ReflectionConstructable2<SimNode,Parameters>

All Known Subinterfaces:

BoundedQDisc, ProbabilisticQueuingDiscipline

All Known Implementing Classes:

BoundedFIFOQDisc, BoundedLIFOQDisc, DeficitRoundRobinFairQueuing, FairQueuing, FIFOQDisc, LIFOQDisc, MessageFairQueuing, NoDropBoundedFIFOQDisc, StackableQueuingDiscipline, UnboundedFIFOQDisc, UnboundedLIFOQDisc, UnitFairQueuing

public interface QueuingDiscipline
extends ReflectionConstructable2<SimNode,Parameters>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	QueuingDiscipline.QueueEntry

Field Summary

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

CREATE_INSTANCE_METHOD_NAME

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.
int	getCurrentNumberOfMessages()
long	getCurrentNumberOfUnits()
int	getMaxSizeInUnits()
java.lang.String	getName()
SimNode	getNode()
SimNode	getParent()
boolean	handleMessage(Message msg) Request the QueuingDiscipline to handle the Message.
boolean	isEmpty()
boolean	wouldStore(Message msg)

Method Detail

getMaxSizeInUnits

int getMaxSizeInUnits()

Returns:

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

getName

java.lang.String getName()

getNode

SimNode getNode()

getParent

SimNode getParent()

isEmpty

boolean isEmpty()

wouldStore

boolean wouldStore(Message msg)

Returns:

true if the queue cannot is not willing to store the given message due to its algorithm or constraints (e.g. bounded buffer size).

getCurrentNumberOfMessages

int getCurrentNumberOfMessages()

getCurrentNumberOfUnits

long getCurrentNumberOfUnits()

dequeue

QueuingDiscipline.QueueEntry dequeue()

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

Returns:

The QueuingDiscipline.QueueEntry

handleMessage

boolean handleMessage(Message msg)

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).

Parameters:

msg -

Returns:

if it has accepted the message.

dropScheduledNext

QueuingDiscipline.QueueEntry dropScheduledNext()

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

Returns:

The dropped QueuingDiscipline.QueueEntry