java.lang.Object
org.bzdev.devqsim.SimObject
org.bzdev.devqsim.DefaultSimObject
org.bzdev.devqsim.TaskQueue<AbstractWaitTaskQueue.Parameter>
org.bzdev.devqsim.AbstractWaitTaskQueue
- All Implemented Interfaces:
QueueStatus
,NamedObjectOps
- Direct Known Subclasses:
WaitTaskQueue
Base class for wait task queues.
These queues hold entries indefinitely until released or until the
queue is not frozen. Unless a subclass specifies otherwise, instances
of AbstractWaitTaskQueue are initially frozen so that all entries added
to the queue are queued and not run until explicitly released. When
frozen, the methods
release
,
releaseUpTo
,
clearReleaseCount
, or
freeze
(with an argument
whose value is false
) must be used to allow a wait
task queue to decrease in size. For subclasses in which
freeze
must not be used,
the protected method
setCanFreeze
should be called
with an argument of false after the queue is properly configured.- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Type parameter required by TaskQueue.Nested classes/interfaces inherited from class org.bzdev.devqsim.TaskQueue
TaskQueue.ReleasePolicy
-
Constructor Summary
ConstructorsConstructorDescriptionAbstractWaitTaskQueue
(Simulation sim, boolean intern) Constructor.AbstractWaitTaskQueue
(Simulation sim, String name, boolean intern) Constructor for named queues. -
Method Summary
Modifier and TypeMethodDescriptionAdd a Runnable to the queue.Add a Runnable to the queue given a time event priority.add
(SimObjectCallable callable) Add a Callable bound to a simulation object to the queue.add
(SimObjectCallable callable, double tpriority) Add a Callable bound to a simulation object to the queue given a time event priority.add
(SimObjectRunnable runnable) Add a Runnable bound to a simulation object to the queue.add
(SimObjectRunnable runnable, double tpriority) Add a Runnable bound to a simulation object to the queue given a time event priority.Add a Callable to the queue.Add a Callable to the queue a time event priority.addCallObject
(Object scriptObject) Add a script object to execute to the queue.addCallObject
(Object scriptObject, double tpriority) Add a script object to execute to the queue given a time event priority.addCallScript
(String script) Add a script to the queue.addCallScript
(String script, double tpriority) Add a script to the queue a time event priority.boolean
Add the currently running task thread to a queue.boolean
addCurrentTask
(double tpriority) Add the currently running task thread to a queue given a time event priority.boolean
addCurrentTask
(double tpriority, SimEventCallable callable) Add the currently running task thread to a queue given a time event priority, and SimEventCallable.boolean
addCurrentTask
(SimEventCallable callable) Add the currently running task thread to a queue given a SimEventCallable.Add the currently running task thread to a queue and return the SimulationEvent generated.addCurrentTaskObject
(double tpriority) Given a time event priority, add the currently running task thread to a queue and return the SimulationEvent generated.addTaskObject
(Object scriptObject) Add a script object to be run as a task to the queue.addTaskObject
(Object scriptObject, double tpriority) Add a script object to be run as a task to the queue given a time event priority.addTaskScript
(String script) Add a script to be run as a task to the queue given a processing-time interval.addTaskScript
(String script, double tpriority) Add a script to be run as a task to the queue given a processing-time interval and time event priority.protected 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.protected long
getInterval
(AbstractWaitTaskQueue.Parameter parameter) Find the interval used to schedule a queue entry based on entry's parameters or a default value.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.protected double
getTPriority
(AbstractWaitTaskQueue.Parameter parameter) Find the time event priority used to schedule a queue entry based on the entry's parameters or a default value of 0.0.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<AbstractWaitTaskQueue.Parameter> event, TaskQueueSimEvent<AbstractWaitTaskQueue.Parameter> scheduled) Put an event on the queue.protected TaskQueueSimEvent<AbstractWaitTaskQueue.Parameter>
Take an event off the queue.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
-
AbstractWaitTaskQueue
Constructor.- Parameters:
sim
- the simulationintern
- true of the queue should be interned in the simulation's name table; false otherwise
-
AbstractWaitTaskQueue
public AbstractWaitTaskQueue(Simulation sim, String name, boolean intern) throws IllegalArgumentException Constructor for named 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
-
add
Add a Callable to the queue. When the Callable is scheduled and the corresponding event is processed, its call() method will be executed.- Parameters:
callable
- the Callable to add- Returns:
- the SimulationEvent created; null if the Callable cannot be queued
-
add
Add a Callable to the queue a time event priority. When the Callable is scheduled and the corresponding event is processed, its call() method will be executed.- Parameters:
callable
- the Callable to addtpriority
- the time event priority for the callable- Returns:
- the SimulationEvent created; null if the Callable cannot be queued
-
add
Add a Callable bound to a simulation object to the queue. When the Callable is scheduled and the corresponding event is processed, its call() method will be executed.- Parameters:
callable
- the Callable to add- Returns:
- the SimulationEvent created; null if the Callable cannot be queued
-
add
public TaskQueueSimEvent<AbstractWaitTaskQueue.Parameter> add(SimObjectCallable callable, double tpriority) Add a Callable bound to a simulation object to the queue given a time event priority. When the Callable is scheduled and the corresponding event is processed, its call() method will be executed.- Parameters:
callable
- the Callable to addtpriority
- the time event priority- Returns:
- the SimulationEvent created; null if the Callable cannot be queued
-
addCallScript
Add a script to the queue. When the script is scheduled and the corresponding event is processed, the script will be evaluated.- Parameters:
script
- the script to add to the queue- Returns:
- the SimulationEvent created; null if the Callable cannot be queued
-
addCallScript
public TaskQueueSimEvent<AbstractWaitTaskQueue.Parameter> addCallScript(String script, double tpriority) Add a script to the queue a time event priority. When the script is scheduled and the corresponding event is processed, the script will be evaluated.- Parameters:
script
- the script to add to the queuetpriority
- the time event priority- Returns:
- the SimulationEvent created; null if the Callable cannot be queued
-
addCallObject
Add a script object to execute to the queue. When the script is scheduled and the corresponding event is processed, the script object'scall
method will be executed.- Parameters:
scriptObject
- the script object to add- Returns:
- the SimulationEvent created; null if the Callable cannot be queued
-
addCallObject
public TaskQueueSimEvent<AbstractWaitTaskQueue.Parameter> addCallObject(Object scriptObject, double tpriority) Add a script object to execute to the queue given a time event priority. When the script is scheduled and the corresponding event is processed, the script object'scall
method will be executed.- Parameters:
scriptObject
- the script object to addtpriority
- the time event priority- Returns:
- the SimulationEvent created; null if the Callable cannot be queued
-
add
Add a Runnable to the queue. When the Runnable is scheduled and the corresponding event is processed, a task thread will be started executing the Runnable. Task threads and the simulation's thread run one at a time, including on a multiprocessor.- Parameters:
runnable
- the Runnable to add to the queue- Returns:
- the SimulationEvent created; null if the Runnable cannot be queued
-
add
Add a Runnable to the queue given a time event priority. When the Runnable is scheduled and the corresponding event is processed, a task thread will be started executing the Runnable. Task threads and the simulation's thread run one at a time, including on a multiprocessor.- Parameters:
runnable
- the Runnable to add to the queuetpriority
- the time event priority- Returns:
- the SimulationEvent created; null if the Runnable cannot be queued
-
add
Add a Runnable bound to a simulation object to the queue. When the Runnable is scheduled and the corresponding event is processed, a task thread will be started executing the Runnable. Task threads and the simulation's thread run one at a time, including on a multiprocessor.- Parameters:
runnable
- the Runnable to add to the queue- Returns:
- the SimulationEvent created; null if the Runnable cannot be queued
-
add
public TaskQueueSimEvent<AbstractWaitTaskQueue.Parameter> add(SimObjectRunnable runnable, double tpriority) Add a Runnable bound to a simulation object to the queue given a time event priority. When the Runnable is scheduled and the corresponding event is processed, a task thread will be started executing the Runnable. Task threads and the simulation's thread run one at a time, including on a multiprocessor.- Parameters:
runnable
- the Runnable to add to the queuetpriority
- the time event priority- Returns:
- the SimulationEvent created; null if the Runnable cannot be queued
-
addTaskScript
Add a script to be run as a task to the queue given a processing-time interval. When script is scheduled and the corresponding event is processed, a task thread will be started executing the script by evaluating it. Task threads and the simulation's thread run one at a time, including on a multiprocessor.- Parameters:
script
- the script representing a task to be added to the queue- Returns:
- the SimulationEvent created; null if the Runnable cannot be queued
-
addTaskScript
public TaskQueueSimEvent<AbstractWaitTaskQueue.Parameter> addTaskScript(String script, double tpriority) Add a script to be run as a task to the queue given a processing-time interval and time event priority. When script is scheduled and the corresponding event is processed, a task thread will be started executing the script by evaluating it. Task threads and the simulation's thread run one at a time, including on a multiprocessor.- Parameters:
script
- the script representing a task to be added to the queuetpriority
- the time event priority- Returns:
- the SimulationEvent created; null if the Runnable cannot be queued
-
addTaskObject
Add a script object to be run as a task to the queue. When the object is scheduled and the corresponding event is processed, a task thread will be started and the object'srun()
method will be called. Task threads and the simulation's thread run one at a time, including on a multiprocessor.- Parameters:
scriptObject
- the object representing a task to be added to the queue- Returns:
- the SimulationEvent created; null if the Runnable cannot be queued
-
addTaskObject
public TaskQueueSimEvent<AbstractWaitTaskQueue.Parameter> addTaskObject(Object scriptObject, double tpriority) Add a script object to be run as a task to the queue given a time event priority. When the object is scheduled and the corresponding event is processed, a task thread will be started and the object'srun()
method will be called. Task threads and the simulation's thread run one at a time, including on a multiprocessor.- Parameters:
scriptObject
- the object representing a task to be added to the queuetpriority
- the time event priority- Returns:
- the SimulationEvent created; null if the Runnable cannot be queued
-
getInterval
Description copied from class:TaskQueue
Find the interval used to schedule a queue entry based on entry's parameters or a default value.- Specified by:
getInterval
in classTaskQueue<AbstractWaitTaskQueue.Parameter>
- Parameters:
parameter
- the parameters for a queue entry- Returns:
- the interval in units of simulation ticks
-
getTPriority
Description copied from class:TaskQueue
Find the time event priority used to schedule a queue entry based on the entry's parameters or a default value of 0.0.- Overrides:
getTPriority
in classTaskQueue<AbstractWaitTaskQueue.Parameter>
- Parameters:
parameter
- the parameters for a queue entry- Returns:
- the priority
-
addCurrentTask
Add the currently running task thread to a queue.- Returns:
- true on success; false on failure in which case the current thread will continue to run
- Throws:
IllegalStateException
-
addCurrentTask
Add the currently running task thread to a queue given a time event priority.- Parameters:
tpriority
- the time event priority- Returns:
- true on success; false on failure in which case the current thread will continue to run
- Throws:
IllegalStateException
-
addCurrentTask
Add the currently running task thread to a queue given a SimEventCallable.- Parameters:
callable
- a SimEventCallable used to provide access to the event representing the queued task- Returns:
- true on success; false on failure in which case the current thread will continue to run
- Throws:
IllegalStateException
-
addCurrentTask
public boolean addCurrentTask(double tpriority, SimEventCallable callable) throws IllegalStateException Add the currently running task thread to a queue given a time event priority, and SimEventCallable.- Parameters:
tpriority
- the time event prioritycallable
- a SimEventCallable used to provide access to the event representing the queued task- Returns:
- true on success; false on failure in which case the current thread will continue to run
- Throws:
IllegalStateException
-
addCurrentTaskObject
Add the currently running task thread to a queue and return the SimulationEvent generated.- Returns:
- a simulation event on success; null on failure in which case the current thread will continue to run
- Throws:
IllegalStateException
-
addCurrentTaskObject
Given a time event priority, add the currently running task thread to a queue and return the SimulationEvent generated.- Parameters:
tpriority
- the time event priority- Returns:
- a simulation event on success; null on failure in which case the current thread will continue to run
- Throws:
IllegalStateException
-
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<AbstractWaitTaskQueue.Parameter>
- Returns:
- the queue size
-
offerToQueue
protected boolean offerToQueue(TaskQueueSimEvent<AbstractWaitTaskQueue.Parameter> event, TaskQueueSimEvent<AbstractWaitTaskQueue.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<AbstractWaitTaskQueue.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<AbstractWaitTaskQueue.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
-