java.lang.Object
org.bzdev.devqsim.SimObject
org.bzdev.devqsim.DefaultSimObject
org.bzdev.devqsim.TaskQueue<DelayTaskQueue.Parameter>
org.bzdev.devqsim.DelayTaskQueue
org.bzdev.devqsim.FifoTaskQueue
- All Implemented Interfaces:
QueueStatus
,NamedObjectOps
FIFO (First In First Out) delay queue.
Task threads and classes that implement the Runnable or Callable
interfaces can be put on this queue. The delay for each entry
is the time between when the entry is scheduled and restarted, run,
or called.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.bzdev.devqsim.DelayTaskQueue
DelayTaskQueue.Parameter
Nested classes/interfaces inherited from class org.bzdev.devqsim.TaskQueue
TaskQueue.ReleasePolicy
-
Constructor Summary
ConstructorsConstructorDescriptionFifoTaskQueue
(Simulation sim, boolean intern) Constructor.FifoTaskQueue
(Simulation sim, String name, boolean intern) Constructor for named FIFO queues. -
Method Summary
Modifier and TypeMethodDescriptionprotected Object
clone()
Creates and returns a copy of this object.final boolean
delete()
Delete an object.final boolean
Determine if an object is being deleted.final String
getName()
Get an object's name.protected Simulation
Get the object namer for a named object.protected int
getSize()
Get the raw size of the queue.final boolean
Determine if an object has been deleted.boolean
Determine if an object is interned in a object namer's tables.protected boolean
offerToQueue
(TaskQueueSimEvent<DelayTaskQueue.Parameter> event, TaskQueueSimEvent<DelayTaskQueue.Parameter> scheduled) Put an event on the queue.protected TaskQueueSimEvent<DelayTaskQueue.Parameter>
Take an event off the queue.Methods inherited from class org.bzdev.devqsim.DelayTaskQueue
add, add, add, add, add, add, add, add, addCallObject, addCallObject, addCallScript, addCallScript, addCurrentTask, addCurrentTask, addCurrentTask, addCurrentTask, addCurrentTaskObject, addCurrentTaskObject, addTaskObject, addTaskObject, addTaskScript, addTaskScript, getInterval, getTPriority
Methods inherited from class org.bzdev.devqsim.TaskQueue
addCurrentTask, addCurrentTask, addCurrentTaskObject, addObserver, canDelete, canFreeze, canPreempt, canRelease, clearReleaseCount, doAdd, doAdd, doAdd, doAdd, doAddCallObject, doAddCallScript, doAddTaskObject, doAddTaskScript, forceClearReleaseCount, forceFreeze, forceRelease, forceReleaseUpTo, forceSetReleasePolicy, freeze, getDeletePolicy, getEventParameters, getOffQueueTime, getReleasePolicy, init, inUseCount, isBusy, isFrozen, isProcessing, onDelete, pauseCurrentTask, pauseCurrentTask, preempt, printConfiguration, printState, release, releaseUpTo, removeObserver, replaceScheduledEvent, serverCount, setCanFreeze, setCanRelease, setDeletePolicy, setEventParameters, setReleasePolicy, size, tryRemove
Methods inherited from class org.bzdev.devqsim.DefaultSimObject
getSimulation
Methods inherited from class org.bzdev.devqsim.SimObject
addSimulationListener, addTraceSet, bindCallable, bindCallable, bindCallable, bindCallable, bindRunnable, bindRunnable, bindRunnable, bindRunnable, callableObject, callableScript, callScriptFunction, callScriptMethod, clearTraceSets, evalScript, getEventListenerList, getScriptObject, getTraceSets, printConfiguration, printConfiguration, printConfiguration, printConfiguration, printConfiguration, printConfiguration, printState, printState, printState, printState, printState, printState, putScriptObject, removeSimulationListener, removeTraceSet, runnableObject, runnableScript, scheduleCall, scheduleCall, scheduleCall, scheduleCall, scheduleCallObject, scheduleScript, scheduleTask, scheduleTask, scheduleTask, scheduleTask, scheduleTaskObject, scheduleTaskScript, startImmediateTask, startImmediateTask, trace, trace, unscheduledTaskThread, unscheduledTaskThread, update, update, usesTraceSet
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.bzdev.obnaming.NamedObjectOps
delete, deletePending, getName, isDeleted, isInterned
Methods inherited from interface org.bzdev.devqsim.QueueStatus
getName, isDeleted, isInterned
-
Constructor Details
-
FifoTaskQueue
Constructor.- Parameters:
sim
- the simulationintern
- true of the queue should be interned in the simulation's name table; false otherwise
-
FifoTaskQueue
Constructor for named FIFO queues.- Parameters:
sim
- the simulationname
- the name for the queueintern
- true of the queue should be interned in the simulation's name table; false otherwise- Throws:
IllegalArgumentException
- typically means a name is already in use
-
-
Method Details
-
getSize
protected int getSize()Description copied from class:TaskQueue
Get the raw size of the queue. The size does not include the currently scheduled event. It does contain any events that were canceled but could not be removed.- Specified by:
getSize
in classTaskQueue<DelayTaskQueue.Parameter>
- Returns:
- the queue size
-
offerToQueue
protected boolean offerToQueue(TaskQueueSimEvent<DelayTaskQueue.Parameter> event, TaskQueueSimEvent<DelayTaskQueue.Parameter> scheduled) Description copied from class:TaskQueue
Put an event on the queue. This method should be implemented by subclasses, which should also provide a queue on which to store an event. Normally an event is just added to the end of the queue. For some cases (e.g., a LIFO queue), one may need to preempt a currently scheduled event. If preemption is necessary, the preempted event's time parameters will have to be adjusted and the new event will have to become the scheduled event. The latter operation is handled byreplaceScheduledEvent
. If replaceScheduledEvent is used, care must be taken if the queue insertion could fail (e.g., the case of a finite-sized queue). For modifying the event parameters (e.g., to allow for time already attributed to processing an event), the methodsgetOffQueueTime
andgetEventParameters
may be useful.- Specified by:
offerToQueue
in classTaskQueue<DelayTaskQueue.Parameter>
- Parameters:
event
- the eventscheduled
- the event that is currently scheduled for processing; null if there is none or if preempt mode is turned off- Returns:
- true if an event was successfully added to the queue; false otherwise
-
pollFromQueue
Description copied from class:TaskQueue
Take an event off the queue. This method should be implemented by subclasses, which should also provide a queue on which to store an event.- Specified by:
pollFromQueue
in classTaskQueue<DelayTaskQueue.Parameter>
- Returns:
- the event; null if the queue is empty
-
clone
Creates and returns a copy of this object. This method will throw the exception CloneNotSupportedException if the object is interned.- Overrides:
clone
in classObject
- Throws:
CloneNotSupportedException
- a clone could not be created- See Also:
-
isInterned
public boolean isInterned()Determine if an object is interned in a object namer's tables.- Specified by:
isInterned
in interfaceNamedObjectOps
- Returns:
- true if the object is interned; false if not
-
getObjectNamer
Get the object namer for a named object.- Returns:
- the object namer for this named object
-
getName
Get an object's name.- Specified by:
getName
in interfaceNamedObjectOps
- Returns:
- the name of the object
-
delete
public final boolean delete()Delete an object. An object can only be deleted once. If this method returns true, the object (if interned) will have been removed from the object namer tables.The implementations provided by
DefaultNamedObect
and generated because of a@NamedObject
annotation provide a protected method named onDelete. A subclass that overrides onDelete() must call the onDelete method of its superclass after it's onDelete method has been called and any cleanup actions performed. In some cases, this may happen at a later time (e.g., if a thread is used for some of the cleanup operations or if it is otherwise necessary to wait).- Specified by:
delete
in interfaceNamedObjectOps
- Returns:
- true if the deletion request was accepted; false otherwise
-
isDeleted
public final boolean isDeleted()Determine if an object has been deleted. An object is deleted if the method delete() has been called and returned true.- Specified by:
isDeleted
in interfaceNamedObjectOps
- Returns:
- true if deleted; false otherwise
-
deletePending
public final boolean deletePending()Determine if an object is being deleted. An deletion is pending if the method delete() has been called and returned true but the deletion has not been completed.- Specified by:
deletePending
in interfaceNamedObjectOps
- Returns:
- true if deletion is pending; false otherwise
-