Class SchedulerQueue
- java.lang.Object
-
- org.simpleframework.common.thread.SchedulerQueue
-
class SchedulerQueue extends java.lang.Object
TheSchedulerQueue
object is used to schedule tasks for execution. This queues the task for the requested period of time before it is executed. It ensures that the delay is adhered to such that tasks can be timed for execution in an accurate way.
-
-
Constructor Summary
Constructors Constructor Description SchedulerQueue(java.lang.Class type, int size)
Constructor for theSchedulerQueue
object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
execute(java.lang.Runnable task)
Theexecute
method is used to queue the task for execution.void
execute(java.lang.Runnable task, long delay)
This will execute the task within the executor after the time specified has expired.void
execute(java.lang.Runnable task, long delay, java.util.concurrent.TimeUnit unit)
This will execute the task within the executor after the time specified has expired.void
stop()
This is used to stop the executor by interrupting all running tasks and shutting down the threads within the pool.void
stop(long wait)
This is used to stop the executor by interrupting all running tasks and shutting down the threads within the pool.
-
-
-
Constructor Detail
-
SchedulerQueue
public SchedulerQueue(java.lang.Class type, int size)
Constructor for theSchedulerQueue
object. This will create a scheduler with a fixed number of threads to use before execution. Depending on the types of task that are to be executed this should be increased for accuracy.- Parameters:
type
- this is the type of task to executesize
- this is the number of threads for the scheduler
-
-
Method Detail
-
execute
public void execute(java.lang.Runnable task)
Theexecute
method is used to queue the task for execution. If all threads are busy the provided task is queued and waits until all current and outstanding tasks are finished.- Parameters:
task
- this is the task to be queued for execution
-
execute
public void execute(java.lang.Runnable task, long delay)
This will execute the task within the executor after the time specified has expired. If the time specified is zero then it will be executed immediately. Once the scheduler has been stopped then this method will no longer accept runnable tasks.- Parameters:
task
- this is the task to schedule for executiondelay
- the time in milliseconds to wait for execution
-
execute
public void execute(java.lang.Runnable task, long delay, java.util.concurrent.TimeUnit unit)
This will execute the task within the executor after the time specified has expired. If the time specified is zero then it will be executed immediately. Once the scheduler has been stopped then this method will no longer accept runnable tasks.- Parameters:
task
- this is the task to schedule for executiondelay
- this is the delay to wait before executionunit
- this is the duration time unit to wait for
-
stop
public void stop()
This is used to stop the executor by interrupting all running tasks and shutting down the threads within the pool. This will return once it has been stopped, and no further tasks will be accepted by this pool for execution.
-
stop
public void stop(long wait)
This is used to stop the executor by interrupting all running tasks and shutting down the threads within the pool. This will return once it has been stopped, and no further tasks will be accepted by this pool for execution.- Parameters:
wait
- the number of milliseconds to wait for it to stop
-
-