Class AbstractScheduledEventExecutor

java.lang.Object

java.util.concurrent.AbstractExecutorService

io.netty.util.concurrent.AbstractEventExecutor

io.netty.util.concurrent.AbstractScheduledEventExecutor

All Implemented Interfaces:

EventExecutor, EventExecutorGroup, Iterable<EventExecutor>, Executor, ExecutorService, ScheduledExecutorService

Direct Known Subclasses:

GlobalEventExecutor, SingleThreadEventExecutor

public abstract class AbstractScheduledEventExecutor
extends AbstractEventExecutor

Abstract base class for EventExecutors that want to support scheduling.

Nested Class Summary

Nested classes/interfaces inherited from class AbstractEventExecutor

AbstractEventExecutor.LazyRunnable

Modifier and Type	Class	Description
static interface	AbstractEventExecutor.LazyRunnable	Deprecated. override SingleThreadEventExecutor.wakesUpForTask(Runnable) to re-create this behaviour

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractScheduledEventExecutor()
protected	AbstractScheduledEventExecutor(EventExecutorGroup parent)

Method Summary

Modifier and Type	Method	Description
protected boolean	afterScheduledTaskSubmitted(long deadlineNanos)	See beforeScheduledTaskSubmitted(long).
protected boolean	beforeScheduledTaskSubmitted(long deadlineNanos)	Called from arbitrary non-EventExecutor threads prior to scheduled task submission.
protected void	cancelScheduledTasks()	Cancel all scheduled tasks.
protected static long	deadlineToDelayNanos(long deadlineNanos)	Given an arbitrary deadline deadlineNanos, calculate the number of nano seconds from now deadlineNanos would expire.
protected long	getCurrentTimeNanos()	Get the current time in nanoseconds by this executor's clock.
protected final boolean	hasScheduledTasks()	Returns true if a scheduled task is ready for processing.
protected static long	initialNanoTime()	The initial value used for delay and computations based upon a monatomic time source.
protected static long	nanoTime()	Deprecated. Use the non-static getCurrentTimeNanos() instead.
protected final long	nextScheduledTaskDeadlineNanos()	Return the deadline (in nanoseconds) when the next scheduled task is ready to be run or -1 if no task is scheduled.
protected final long	nextScheduledTaskNano()	Return the nanoseconds until the next scheduled task is ready to be run or -1 if no task is scheduled.
protected final Runnable	pollScheduledTask()
protected final Runnable	pollScheduledTask(long nanoTime)	Return the Runnable which is ready to be executed with the given nanoTime.
ScheduledFuture<?>	schedule(Runnable command, long delay, TimeUnit unit)
<V> ScheduledFuture<V>	schedule(Callable<V> callable, long delay, TimeUnit unit)
ScheduledFuture<?>	scheduleAtFixedRate(Runnable command, long initialDelay, long period, TimeUnit unit)
ScheduledFuture<?>	scheduleWithFixedDelay(Runnable command, long initialDelay, long delay, TimeUnit unit)
protected void	validateScheduled(long amount, TimeUnit unit)	Deprecated. will be removed in the future.

Methods inherited from class AbstractEventExecutor

inEventLoop, iterator, lazyExecute, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, newTaskFor, newTaskFor, next, parent, runTask, safeExecute, shutdown, shutdownGracefully, shutdownNow, submit, submit, submit

Modifier and Type	Method	Description
boolean	inEventLoop()	Calls EventExecutor.inEventLoop(Thread) with Thread.currentThread() as argument
Iterator<EventExecutor>	iterator()
void	lazyExecute(Runnable task)	Like Executor.execute(Runnable) but does not guarantee the task will be run until either a non-lazy task is executed or the executor is shut down.
<V> Future<V>	newFailedFuture(Throwable cause)	Create a new Future which is marked as failed already.
<V> ProgressivePromise<V>	newProgressivePromise()	Create a new ProgressivePromise.
<V> Promise<V>	newPromise()	Return a new Promise.
<V> Future<V>	newSucceededFuture(V result)	Create a new Future which is marked as succeeded already.
protected final <T> RunnableFuture<T>	newTaskFor(Runnable runnable, T value)
protected final <T> RunnableFuture<T>	newTaskFor(Callable<T> callable)
EventExecutor	next()	Returns a reference to itself.
EventExecutorGroup	parent()	Return the EventExecutorGroup which is the parent of this EventExecutor,
protected static void	runTask(Runnable task)
protected static void	safeExecute(Runnable task)	Try to execute the given Runnable and just log if it throws a Throwable.
abstract void	shutdown()	Deprecated. EventExecutorGroup.shutdownGracefully(long, long, TimeUnit) or AbstractEventExecutor.shutdownGracefully() instead.
Future<?>	shutdownGracefully()	Shortcut method for EventExecutorGroup.shutdownGracefully(long, long, TimeUnit) with sensible default values.
List<Runnable>	shutdownNow()	Deprecated. EventExecutorGroup.shutdownGracefully(long, long, TimeUnit) or AbstractEventExecutor.shutdownGracefully() instead.
Future<?>	submit(Runnable task)
<T> Future<T>	submit(Runnable task, T result)
<T> Future<T>	submit(Callable<T> task)

Methods inherited from class AbstractExecutorService

invokeAll, invokeAll, invokeAny, invokeAny

Methods inherited from class Object

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

Methods inherited from interface EventExecutor

inEventLoop

Modifier and Type	Method	Description
boolean	inEventLoop(Thread thread)	Return true if the given Thread is executed in the event loop, false otherwise.

Methods inherited from interface EventExecutorGroup

isShuttingDown, shutdownGracefully, terminationFuture

Modifier and Type	Method	Description
boolean	isShuttingDown()	Returns true if and only if all EventExecutors managed by this EventExecutorGroup are being shut down gracefully or was shut down.
Future<?>	shutdownGracefully(long quietPeriod, long timeout, TimeUnit unit)	Signals this executor that the caller wants the executor to be shut down.
Future<?>	terminationFuture()	Returns the Future which is notified when all EventExecutors managed by this EventExecutorGroup have been terminated.

Methods inherited from interface Executor

execute

Methods inherited from interface ExecutorService

awaitTermination, isShutdown, isTerminated

Methods inherited from interface Iterable

forEach, spliterator

Constructor Details

AbstractScheduledEventExecutor

protected AbstractScheduledEventExecutor()

AbstractScheduledEventExecutor

protected AbstractScheduledEventExecutor(EventExecutorGroup parent)

Method Details

getCurrentTimeNanos

protected long getCurrentTimeNanos()

Get the current time in nanoseconds by this executor's clock. This is not the same as System.nanoTime() for two reasons:

• We apply a fixed offset to the nanoTime
• Implementations (in particular EmbeddedEventLoop) may use their own time source so they can control time for testing purposes.

nanoTime

@Deprecated
protected static long nanoTime()

Deprecated.

Use the non-static getCurrentTimeNanos() instead.

deadlineToDelayNanos

protected static long deadlineToDelayNanos(long deadlineNanos)

Given an arbitrary deadline deadlineNanos, calculate the number of nano seconds from now deadlineNanos would expire.

Parameters:

deadlineNanos - An arbitrary deadline in nano seconds.

Returns:

the number of nano seconds from now deadlineNanos would expire.

initialNanoTime

protected static long initialNanoTime()

The initial value used for delay and computations based upon a monatomic time source.

Returns:

initial value used for delay and computations based upon a monatomic time source.

cancelScheduledTasks

protected void cancelScheduledTasks()

Cancel all scheduled tasks. This method MUST be called only when AbstractEventExecutor.inEventLoop() is true.

pollScheduledTask

protected final Runnable pollScheduledTask()

See Also:

• pollScheduledTask(long)

pollScheduledTask

protected final Runnable pollScheduledTask(long nanoTime)

Return the Runnable which is ready to be executed with the given nanoTime. You should use getCurrentTimeNanos() to retrieve the correct nanoTime.

nextScheduledTaskNano

protected final long nextScheduledTaskNano()

Return the nanoseconds until the next scheduled task is ready to be run or -1 if no task is scheduled.

nextScheduledTaskDeadlineNanos

protected final long nextScheduledTaskDeadlineNanos()

Return the deadline (in nanoseconds) when the next scheduled task is ready to be run or -1 if no task is scheduled.

hasScheduledTasks

protected final boolean hasScheduledTasks()

Returns true if a scheduled task is ready for processing.

schedule

public ScheduledFuture<?> schedule(Runnable command,
 long delay,
 TimeUnit unit)

Specified by:

schedule in interface EventExecutorGroup

Specified by:

schedule in interface ScheduledExecutorService

Overrides:

schedule in class AbstractEventExecutor

schedule

public <V> ScheduledFuture<V> schedule(Callable<V> callable,
 long delay,
 TimeUnit unit)

Specified by:

schedule in interface EventExecutorGroup

Specified by:

schedule in interface ScheduledExecutorService

Overrides:

schedule in class AbstractEventExecutor

scheduleAtFixedRate

public ScheduledFuture<?> scheduleAtFixedRate(Runnable command,
 long initialDelay,
 long period,
 TimeUnit unit)

Specified by:

scheduleAtFixedRate in interface EventExecutorGroup

Specified by:

scheduleAtFixedRate in interface ScheduledExecutorService

Overrides:

scheduleAtFixedRate in class AbstractEventExecutor

scheduleWithFixedDelay

public ScheduledFuture<?> scheduleWithFixedDelay(Runnable command,
 long initialDelay,
 long delay,
 TimeUnit unit)

Specified by:

scheduleWithFixedDelay in interface EventExecutorGroup

Specified by:

scheduleWithFixedDelay in interface ScheduledExecutorService

Overrides:

scheduleWithFixedDelay in class AbstractEventExecutor

validateScheduled

@Deprecated
protected void validateScheduled(long amount,
 TimeUnit unit)

Deprecated.

will be removed in the future.

Sub-classes may override this to restrict the maximal amount of time someone can use to schedule a task.

beforeScheduledTaskSubmitted

protected boolean beforeScheduledTaskSubmitted(long deadlineNanos)

Called from arbitrary non-EventExecutor threads prior to scheduled task submission. Returns true if the EventExecutor thread should be woken immediately to process the scheduled task (if not already awake).

If false is returned, afterScheduledTaskSubmitted(long) will be called with the same value after the scheduled task is enqueued, providing another opportunity to wake the EventExecutor thread if required.

Parameters:

deadlineNanos - deadline of the to-be-scheduled task relative to getCurrentTimeNanos()

Returns:

true if the EventExecutor thread should be woken, false otherwise

afterScheduledTaskSubmitted

protected boolean afterScheduledTaskSubmitted(long deadlineNanos)

See beforeScheduledTaskSubmitted(long). Called only after that method returns false.

Parameters:

deadlineNanos - relative to getCurrentTimeNanos()

Returns:

true if the EventExecutor thread should be woken, false otherwise