ikr.simlib.entities.queues

Class BoundedFIFOQueue

java.lang.Object

ikr.simlib.entities.Entity

ikr.simlib.entities.queues.Queue

ikr.simlib.entities.queues.FIFOQueue

ikr.simlib.entities.queues.BoundedFIFOQueue

public class BoundedFIFOQueue
extends FIFOQueue

This class implements a bounded FIFO (First In First Out) queue, i.e., it has a finite buffer size. If a new message arrives and there is not enough buffer space left in the queue to store the message, the arriving message is lost, i.e., it is deleted by the HandleLossMessage()-method. You can overwrite this virtual method if you want something else to be done with the message.

Nested Class Summary

Nested classes/interfaces inherited from class ikr.simlib.entities.queues.Queue

Queue.QueueEntry

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

Entity.PortAlias

Field Summary

Fields

Modifier and Type	Field and Description
protected int	maxSizeInUnits

Fields inherited from class ikr.simlib.entities.queues.FIFOQueue

queue

Fields inherited from class ikr.simlib.entities.queues.Queue

currentNumberOfUnits, inputPort, lossProbability, numberOfMessages, numberOfUnits, outputPort, transferTime, waitingTime

Fields inherited from class ikr.simlib.entities.Entity

portAliases, ports, simNode

Constructor Summary

Constructors

Constructor and Description
BoundedFIFOQueue(int size, java.lang.String name, SimNode owner)
BoundedFIFOQueue(Parameters pars, java.lang.String name, SimNode owner)

Method Summary

Methods

Modifier and Type	Method and Description
int	getMaxSizeInUnits()
boolean	isFull(Message msg)

Methods inherited from class ikr.simlib.entities.queues.FIFOQueue

get, getCurrentNumberOfMessages, getCurrentNumberOfUnits, isEmpty, put

Methods inherited from class ikr.simlib.entities.queues.Queue

getInput, getOutput, handleGetMessage, handleIsMessageAvailable, handleLossMessage, handleMessageIndication

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

maxSizeInUnits

protected int maxSizeInUnits

Constructor Detail

BoundedFIFOQueue

public BoundedFIFOQueue(int size,
                java.lang.String name,
                SimNode owner)

BoundedFIFOQueue

public BoundedFIFOQueue(Parameters pars,
                java.lang.String name,
                SimNode owner)

Method Detail

isFull

public boolean isFull(Message msg)

Specified by:

isFull in class Queue

Returns:

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

getMaxSizeInUnits

public int getMaxSizeInUnits()

Overrides:

getMaxSizeInUnits in class FIFOQueue

Returns:

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