- All Implemented Interfaces:
QueueStatus
,NamedObjectOps
- Direct Known Subclasses:
FifoTaskQueue
,LifoTaskQueue
Common code for FIFO and LIFO delay queues.
-
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
ConstructorsConstructorDescriptionDelayTaskQueue
(Simulation sim, boolean intern) Constructor.DelayTaskQueue
(Simulation sim, String name, boolean intern) Constructor for named queues. -
Method Summary
Modifier and TypeMethodDescriptionAdd a Runnable to the queue given a processing-time interval.Add a Runnable to the queue given a processing-time interval and time event priority.add
(SimObjectCallable callable, long interval) Add a Callable bound to a simulation object to the queue given a processing-time interval.add
(SimObjectCallable callable, long interval, double tpriority) Add a Callable bound to a simulation object to the queue given a processing-time interval and time event priority.add
(SimObjectRunnable runnable, long interval) Add a Runnable bound to a simulation object to the queue given a processing-time interval.add
(SimObjectRunnable runnable, long interval, double tpriority) Add a Runnable bound to a simulation object to the queue given a processing-time interval and time event priority.Add a Callable to the queue given a processing-time interval.Add a Callable to the queue given a processing-time interval and a time event priority.addCallObject
(Object scriptObject, long interval) Add a script object to execute to the queue given a processing-time interval.addCallObject
(Object scriptObject, long interval, double tpriority) Add a script object to execute to the queue given a processing-time interval and time event priority.addCallScript
(String script, long interval) Add a script to the queue given a processing-time interval.addCallScript
(String script, long interval, double tpriority) Add a script to the queue given a processing-time interval and a time event priority.boolean
addCurrentTask
(long delay) Add the currently running task thread to a queue given a processing-time interval.boolean
addCurrentTask
(long delay, double tpriority) Add the currently running task thread to a queue given a processing-time interval and time event priority.boolean
addCurrentTask
(long delay, double tpriority, SimEventCallable callable) Add the currently running task thread to a queue given a processing-time interval, time event priority, and SimEventCallable.boolean
addCurrentTask
(long delay, SimEventCallable callable) Add the currently running task thread to a queue given a processing-time interval and SimEventCallable.addCurrentTaskObject
(long delay) Given a processing-time interval, add the currently running task thread to a queue and return the SimulationEvent generated.addCurrentTaskObject
(long delay, double tpriority) Given a processing-time interval and time event priority, add the currently running task thread to a queue and return the SimulationEvent generated.addTaskObject
(Object scriptObject, long interval) Add a script object to be run as a task to the queue given a processing-time interval.addTaskObject
(Object scriptObject, long interval, double tpriority) Add a script object to be run as a task to the queue given a processing-time interval and time event priority.addTaskScript
(String script, long interval) Add a script to be run as a task to the queue given a processing-time interval.addTaskScript
(String script, long interval, 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
(DelayTaskQueue.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 double
getTPriority
(DelayTaskQueue.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.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, getSize, init, inUseCount, isBusy, isFrozen, isProcessing, offerToQueue, onDelete, pauseCurrentTask, pauseCurrentTask, pollFromQueue, 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
-
DelayTaskQueue
Constructor.- Parameters:
sim
- the simulationintern
- true of the queue should be interned in the simulation's name table; false otherwise
-
DelayTaskQueue
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 given a processing-time interval. When the Callable is scheduled and the corresponding event is processed, its call() method will be executed.- Parameters:
callable
- the Callable to addinterval
- the processing-time interval for the callable, representing the service time for this queue entry.- Returns:
- the SimulationEvent created; null if the Callable cannot be queued
-
add
public TaskQueueSimEvent<DelayTaskQueue.Parameter> add(Callable callable, long interval, double tpriority) Add a Callable to the queue given a processing-time interval and 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 addinterval
- the processing-time interval for the callable, representing the service time for this queue entrytpriority
- 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 given a processing-time interval. When the Callable is scheduled and the corresponding event is processed, its call() method will be executed.- Parameters:
callable
- the Callable to addinterval
- the processing-time interval for the callable, representing the service time for this queue entry.- Returns:
- the SimulationEvent created; null if the Callable cannot be queued
-
add
public TaskQueueSimEvent<DelayTaskQueue.Parameter> add(SimObjectCallable callable, long interval, double tpriority) Add a Callable bound to a simulation object to the queue given a processing-time interval and 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 addinterval
- the processing-time interval for the callable, representing the service time for this queue entry.tpriority
- the time event priority- Returns:
- the SimulationEvent created; null if the Callable cannot be queued
-
addCallScript
Add a script to the queue given a processing-time interval. When the script is scheduled and the corresponding event is processed, the script will be evaluated.- Parameters:
script
- the script to add to the queueinterval
- the processing-time interval for the script, representing the service time for this queue entry.- Returns:
- the SimulationEvent created; null if the Callable cannot be queued
-
addCallScript
public TaskQueueSimEvent<DelayTaskQueue.Parameter> addCallScript(String script, long interval, double tpriority) Add a script to the queue given a processing-time interval and 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 queueinterval
- the processing-time interval for the script, representing the service time for this queue entry.tpriority
- the time event priority- Returns:
- the SimulationEvent created; null if the Callable cannot be queued
-
addCallObject
public TaskQueueSimEvent<DelayTaskQueue.Parameter> addCallObject(Object scriptObject, long interval) Add a script object to execute to the queue given a processing-time interval. 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 addinterval
- the processing-time interval for the scriptObject argument, representing the service time for this queue entry.- Returns:
- the SimulationEvent created; null if the Callable cannot be queued
-
addCallObject
public TaskQueueSimEvent<DelayTaskQueue.Parameter> addCallObject(Object scriptObject, long interval, double tpriority) Add a script object to execute to the queue given a processing-time interval and 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 addinterval
- the processing-time interval for the scriptObject argument, representing the service time for this queue entry.tpriority
- the time event priority- Returns:
- the SimulationEvent created; null if the Callable cannot be queued
-
add
Add a Runnable to the queue given a processing-time interval. 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 queueinterval
- the processing-time interval for the Runnable, representing the service time for this queue entry.- Returns:
- the SimulationEvent created; null if the Runnable cannot be queued
-
add
public TaskQueueSimEvent<DelayTaskQueue.Parameter> add(Runnable runnable, long interval, double tpriority) Add a Runnable to the queue given a processing-time interval and 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 queueinterval
- the processing-time interval for the Runnable, representing the service time for this queue entry.tpriority
- 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 given a processing-time interval. 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 queueinterval
- the processing-time interval for the Runnable, representing the service time for this queue entry.- Returns:
- the SimulationEvent created; null if the Runnable cannot be queued
-
add
public TaskQueueSimEvent<DelayTaskQueue.Parameter> add(SimObjectRunnable runnable, long interval, double tpriority) Add a Runnable bound to a simulation object to the queue given a processing-time interval and 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 queueinterval
- the processing-time interval for the Runnable, representing the service time for this queue entry.tpriority
- 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 queueinterval
- the processing-time interval for the script, representing the service time for this queue entry.- Returns:
- the SimulationEvent created; null if the Runnable cannot be queued
-
addTaskScript
public TaskQueueSimEvent<DelayTaskQueue.Parameter> addTaskScript(String script, long interval, 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 queueinterval
- the processing-time interval for the script, representing the service time for this queue entry.tpriority
- the time event priority- Returns:
- the SimulationEvent created; null if the Runnable cannot be queued
-
addTaskObject
public TaskQueueSimEvent<DelayTaskQueue.Parameter> addTaskObject(Object scriptObject, long interval) Add a script object to be run as a task to the queue given a processing-time interval. 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 queueinterval
- the processing-time interval for scriptObject, representing the service time for this queue entry- Returns:
- the SimulationEvent created; null if the Runnable cannot be queued
-
addTaskObject
public TaskQueueSimEvent<DelayTaskQueue.Parameter> addTaskObject(Object scriptObject, long interval, double tpriority) Add a script object to be run as a task to the queue given a processing-time interval and 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 queueinterval
- the processing-time interval for scriptObject, representing the service time for this queue entrytpriority
- 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<DelayTaskQueue.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<DelayTaskQueue.Parameter>
- Parameters:
parameter
- the parameters for a queue entry- Returns:
- the priority
-
addCurrentTask
Add the currently running task thread to a queue given a processing-time interval.- Parameters:
delay
- the delay to wait before the task is restarted once scheduled.- 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 processing-time interval and time event priority.- Parameters:
delay
- the delay to wait before the task is restarted once scheduled.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 processing-time interval and SimEventCallable.- Parameters:
delay
- the delay to wait before the task is restarted once scheduled.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(long delay, double tpriority, SimEventCallable callable) throws IllegalStateException Add the currently running task thread to a queue given a processing-time interval, time event priority, and SimEventCallable.- Parameters:
delay
- the delay to wait before the task is restarted once scheduled.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
Given a processing-time interval, add the currently running task thread to a queue and return the SimulationEvent generated.- Parameters:
delay
- the delay to wait before the task is restarted once scheduled.- Returns:
- a simulation event on success; null on failure in which case the current thread will continue to run
- Throws:
IllegalStateException
-
addCurrentTaskObject
public SimulationEvent addCurrentTaskObject(long delay, double tpriority) throws IllegalStateException Given a processing-time interval and time event priority, add the currently running task thread to a queue and return the SimulationEvent generated.- Parameters:
delay
- the delay to wait before the task is restarted once scheduled.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
-
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
-