Package org.jgroups.util

Class TimeScheduler3

java.lang.Object

org.jgroups.util.TimeScheduler3

All Implemented Interfaces:

Runnable, TimeScheduler

public class TimeScheduler3
extends Object
implements TimeScheduler, Runnable

Implementation of TimeScheduler. Uses a DelayQueue to order tasks according to execution times

Since:

3.3

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	TimeScheduler3.RecurringTask	Tasks which runs more than once, either dynamic, fixed-rate or fixed-delay, until cancelled
static class	TimeScheduler3.Task
protected static enum	TimeScheduler3.TaskType

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Log	log
protected boolean	non_blocking_task_handling
protected Executor	pool	Thread pool used to execute the tasks
protected final BlockingQueue<TimeScheduler3.Task>	queue	DelayQueue with tasks being sorted according to execution times (next execution first)
protected Thread	runner	Thread which removes tasks ready to be executed from the queue and submits them to the pool for execution
protected boolean	shut_down_pool
protected ThreadPool	thread_pool
protected ThreadFactory	timer_thread_factory

Constructor Summary

Constructors

Constructor	Description
TimeScheduler3()	Create a scheduler that executes tasks in dynamically adjustable intervals
TimeScheduler3(ThreadFactory factory, int min_threads, int max_threads, long keep_alive_time, int max_queue_size, String rejection_policy)
TimeScheduler3(ThreadFactory factory, int min_threads, int max_threads, long keep_alive_time, BlockingQueue<Runnable> queue, String rejection_policy, boolean thread_pool_enabled)
TimeScheduler3(ThreadPool thread_pool, ThreadFactory factory, boolean start)

Method Summary

Modifier and Type	Method	Description
protected TimeScheduler3.Task	add(TimeScheduler3.Task task)
protected <T> T	condGet(Function<ThreadPoolExecutor,T> getter, T default_value)
protected void	condSet(Consumer<ThreadPoolExecutor> setter)
protected Future<?>	doSchedule(TimeScheduler3.Task task, long initial_delay)
String	dumpTimerTasks()	Returns a list of tasks currently waiting for execution.
void	execute(Runnable task, boolean can_block)
int	getCurrentThreads()	Returns the current threads in the pool, or -1 if not applicable
long	getKeepAliveTime()	Returns the keep alive time (in ms) of the thread pool, or -1 if not applicable
int	getMaxThreads()	Returns the configured max threads, or -1 if not applicable
int	getMinThreads()	Returns the configured core threads, or -1 if not applicable
boolean	getNonBlockingTaskHandling()
int	getQueueSize()
protected boolean	isRunning()
boolean	isShutdown()	Returns true if stop() has been called, false otherwise
void	removeCancelledTasks()
void	run()
Future<?>	schedule(Runnable work, long initial_delay, TimeUnit unit, boolean can_block)
Future<?>	scheduleAtFixedRate(Runnable work, long initial_delay, long delay, TimeUnit unit, boolean can_block)
protected Future<?>	scheduleRecurring(Runnable work, TimeScheduler3.TaskType type, long initial_delay, long delay, TimeUnit unit, boolean can_block)
Future<?>	scheduleWithDynamicInterval(TimeScheduler.Task work, boolean can_block)	Schedule a task for execution at varying intervals.
Future<?>	scheduleWithFixedDelay(Runnable work, long initial_delay, long delay, TimeUnit unit, boolean can_block)
void	setKeepAliveTime(long time)	Sets the keep alive time (in ms) of the thread pool.
void	setMaxThreads(int size)	Sets the max pool size.
void	setMinThreads(int size)	Sets the core pool size.
void	setNonBlockingTaskHandling(boolean b)
void	setThreadFactory(ThreadFactory f)
void	setThreadPool(Executor new_pool)
int	size()	Returns the number of tasks currently in the queue.
void	start()	Starts the runner thread
void	stop()	Stops the timer, cancelling all tasks
protected void	submitToPool(TimeScheduler3.Task task)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jgroups.util.TimeScheduler

execute, schedule, scheduleAtFixedRate, scheduleWithDynamicInterval, scheduleWithFixedDelay

Field Details

pool

protected Executor pool

Thread pool used to execute the tasks

thread_pool

protected ThreadPool thread_pool

queue

protected final BlockingQueue<TimeScheduler3.Task> queue

DelayQueue with tasks being sorted according to execution times (next execution first)

runner

protected volatile Thread runner

Thread which removes tasks ready to be executed from the queue and submits them to the pool for execution

log

protected static final Log log

timer_thread_factory

protected ThreadFactory timer_thread_factory

non_blocking_task_handling

protected boolean non_blocking_task_handling

shut_down_pool

protected boolean shut_down_pool

Constructor Details

TimeScheduler3

public TimeScheduler3()

Create a scheduler that executes tasks in dynamically adjustable intervals

TimeScheduler3

public TimeScheduler3(ThreadFactory factory,
 int min_threads,
 int max_threads,
 long keep_alive_time,
 int max_queue_size,
 String rejection_policy)

TimeScheduler3

public TimeScheduler3(ThreadFactory factory,
 int min_threads,
 int max_threads,
 long keep_alive_time,
 BlockingQueue<Runnable> queue,
 String rejection_policy,
 boolean thread_pool_enabled)

TimeScheduler3

public TimeScheduler3(ThreadPool thread_pool,
 ThreadFactory factory,
 boolean start)

Method Details

setThreadFactory

public void setThreadFactory(ThreadFactory f)

Specified by:

setThreadFactory in interface TimeScheduler

setThreadPool

public void setThreadPool(Executor new_pool)

getMinThreads

public int getMinThreads()

Description copied from interface: TimeScheduler

Returns the configured core threads, or -1 if not applicable

Specified by:

getMinThreads in interface TimeScheduler

Returns:

setMinThreads

public void setMinThreads(int size)

Description copied from interface: TimeScheduler

Sets the core pool size. Can be ignored if not applicable

Specified by:

setMinThreads in interface TimeScheduler

getMaxThreads

public int getMaxThreads()

Description copied from interface: TimeScheduler

Returns the configured max threads, or -1 if not applicable

Specified by:

getMaxThreads in interface TimeScheduler

Returns:

setMaxThreads

public void setMaxThreads(int size)

Description copied from interface: TimeScheduler

Sets the max pool size. Can be ignored if not applicable

Specified by:

setMaxThreads in interface TimeScheduler

getKeepAliveTime

public long getKeepAliveTime()

Description copied from interface: TimeScheduler

Returns the keep alive time (in ms) of the thread pool, or -1 if not applicable

Specified by:

getKeepAliveTime in interface TimeScheduler

setKeepAliveTime

public void setKeepAliveTime(long time)

Description copied from interface: TimeScheduler

Sets the keep alive time (in ms) of the thread pool. Can be ignored if not applicable

Specified by:

setKeepAliveTime in interface TimeScheduler

getCurrentThreads

public int getCurrentThreads()

Description copied from interface: TimeScheduler

Returns the current threads in the pool, or -1 if not applicable

Specified by:

getCurrentThreads in interface TimeScheduler

Returns:

getQueueSize

public int getQueueSize()

size

public int size()

Description copied from interface: TimeScheduler

Returns the number of tasks currently in the queue.

Specified by:

size in interface TimeScheduler

Returns:

The number of tasks currently in the queue.

toString

public String toString()

Overrides:

toString in class Object

isShutdown

public boolean isShutdown()

Description copied from interface: TimeScheduler

Returns true if stop() has been called, false otherwise

Specified by:

isShutdown in interface TimeScheduler

getNonBlockingTaskHandling

public boolean getNonBlockingTaskHandling()

Specified by:

getNonBlockingTaskHandling in interface TimeScheduler

setNonBlockingTaskHandling

public void setNonBlockingTaskHandling(boolean b)

Specified by:

setNonBlockingTaskHandling in interface TimeScheduler

dumpTimerTasks

public String dumpTimerTasks()

Description copied from interface: TimeScheduler

Returns a list of tasks currently waiting for execution. If there are a lot of tasks, the returned string should probably only return the number of tasks rather than a full dump.

Specified by:

dumpTimerTasks in interface TimeScheduler

Returns:

removeCancelledTasks

public void removeCancelledTasks()

Specified by:

removeCancelledTasks in interface TimeScheduler

execute

public void execute(Runnable task,
 boolean can_block)

Specified by:

execute in interface TimeScheduler

schedule

public Future<?> schedule(Runnable work,
 long initial_delay,
 TimeUnit unit,
 boolean can_block)

Specified by:

schedule in interface TimeScheduler

scheduleWithFixedDelay

public Future<?> scheduleWithFixedDelay(Runnable work,
 long initial_delay,
 long delay,
 TimeUnit unit,
 boolean can_block)

Specified by:

scheduleWithFixedDelay in interface TimeScheduler

scheduleAtFixedRate

public Future<?> scheduleAtFixedRate(Runnable work,
 long initial_delay,
 long delay,
 TimeUnit unit,
 boolean can_block)

Specified by:

scheduleAtFixedRate in interface TimeScheduler

scheduleWithDynamicInterval

public Future<?> scheduleWithDynamicInterval(TimeScheduler.Task work,
 boolean can_block)

Schedule a task for execution at varying intervals. After execution, the task will get rescheduled after TimeScheduler.Task.nextInterval() milliseconds. The task is never done until nextInterval() returns a value <= 0 or the task is cancelled.

Note that the task is rescheduled relative to the last time is actually executed. This is similar to TimeScheduler.scheduleWithFixedDelay(Runnable,long,long,java.util.concurrent.TimeUnit).

Specified by:

scheduleWithDynamicInterval in interface TimeScheduler

Parameters:

work - the task to execute

start

public void start()

Description copied from interface: TimeScheduler

Starts the runner thread

Specified by:

start in interface TimeScheduler

stop

public void stop()

Stops the timer, cancelling all tasks

Specified by:

stop in interface TimeScheduler

run

public void run()

Specified by:

run in interface Runnable

scheduleRecurring

protected Future<?> scheduleRecurring(Runnable work,
 TimeScheduler3.TaskType type,
 long initial_delay,
 long delay,
 TimeUnit unit,
 boolean can_block)

doSchedule

protected Future<?> doSchedule(TimeScheduler3.Task task,
 long initial_delay)

condSet

protected void condSet(Consumer<ThreadPoolExecutor> setter)

condGet

protected <T> T condGet(Function<ThreadPoolExecutor,T> getter,
 T default_value)

submitToPool

protected void submitToPool(TimeScheduler3.Task task)

add

protected TimeScheduler3.Task add(TimeScheduler3.Task task)

isRunning

protected boolean isRunning()