Package io.netty.util.concurrent
Class AbstractScheduledEventExecutor
- java.lang.Object
-
- java.util.concurrent.AbstractExecutorService
-
- io.netty.util.concurrent.AbstractEventExecutor
-
- io.netty.util.concurrent.AbstractScheduledEventExecutor
-
- All Implemented Interfaces:
EventExecutor
,EventExecutorGroup
,ThreadAwareExecutor
,java.lang.Iterable<EventExecutor>
,java.util.concurrent.Executor
,java.util.concurrent.ExecutorService
,java.util.concurrent.ScheduledExecutorService
- Direct Known Subclasses:
GlobalEventExecutor
,ManualIoEventLoop
,SingleThreadEventExecutor
public abstract class AbstractScheduledEventExecutor extends AbstractEventExecutor
Abstract base class forEventExecutor
s that want to support scheduling.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class io.netty.util.concurrent.AbstractEventExecutor
AbstractEventExecutor.LazyRunnable
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractScheduledEventExecutor()
protected
AbstractScheduledEventExecutor(EventExecutorGroup parent)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected boolean
afterScheduledTaskSubmitted(long deadlineNanos)
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 deadlinedeadlineNanos
, calculate the number of nano seconds from nowdeadlineNanos
would expire.protected long
delayNanos(long currentTimeNanos, long scheduledPurgeInterval)
Returns the amount of time left until the scheduled task with the closest dead line is executed.protected boolean
fetchFromScheduledTaskQueue(java.util.Queue<java.lang.Runnable> taskQueue)
Fetch scheduled tasks from the internal queue and add these to the givenQueue
.protected long
getCurrentTimeNanos()
Get the current time in nanoseconds by this executor's clock.protected boolean
hasScheduledTasks()
Returnstrue
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-staticgetCurrentTimeNanos()
instead.protected 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 long
nextScheduledTaskNano()
Return the nanoseconds until the next scheduled task is ready to be run or-1
if no task is scheduled.protected java.lang.Runnable
pollScheduledTask()
protected java.lang.Runnable
pollScheduledTask(long nanoTime)
Return theRunnable
which is ready to be executed with the givennanoTime
.ScheduledFuture<?>
schedule(java.lang.Runnable command, long delay, java.util.concurrent.TimeUnit unit)
<V> ScheduledFuture<V>
schedule(java.util.concurrent.Callable<V> callable, long delay, java.util.concurrent.TimeUnit unit)
ScheduledFuture<?>
scheduleAtFixedRate(java.lang.Runnable command, long initialDelay, long period, java.util.concurrent.TimeUnit unit)
ScheduledFuture<?>
scheduleWithFixedDelay(java.lang.Runnable command, long initialDelay, long delay, java.util.concurrent.TimeUnit unit)
protected void
validateScheduled(long amount, java.util.concurrent.TimeUnit unit)
Deprecated.will be removed in the future.-
Methods inherited from class io.netty.util.concurrent.AbstractEventExecutor
iterator, lazyExecute, newTaskFor, newTaskFor, next, parent, runTask, safeExecute, shutdown, shutdownGracefully, shutdownNow, submit, submit, submit
-
Methods inherited from class java.util.concurrent.AbstractExecutorService
invokeAll, invokeAll, invokeAny, invokeAny
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface io.netty.util.concurrent.EventExecutor
inEventLoop, inEventLoop, isExecutorThread, isSuspended, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, trySuspend
-
Methods inherited from interface io.netty.util.concurrent.EventExecutorGroup
isShuttingDown, shutdownGracefully, terminationFuture
-
-
-
-
Constructor Detail
-
AbstractScheduledEventExecutor
protected AbstractScheduledEventExecutor()
-
AbstractScheduledEventExecutor
protected AbstractScheduledEventExecutor(EventExecutorGroup parent)
-
-
Method Detail
-
getCurrentTimeNanos
protected long getCurrentTimeNanos()
Get the current time in nanoseconds by this executor's clock. This is not the same asSystem.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.
- We apply a fixed offset to the
-
nanoTime
@Deprecated protected static long nanoTime()
Deprecated.Use the non-staticgetCurrentTimeNanos()
instead.
-
deadlineToDelayNanos
protected static long deadlineToDelayNanos(long deadlineNanos)
Given an arbitrary deadlinedeadlineNanos
, calculate the number of nano seconds from nowdeadlineNanos
would expire.- Parameters:
deadlineNanos
- An arbitrary deadline in nano seconds.- Returns:
- the number of nano seconds from now
deadlineNanos
would expire.
-
delayNanos
protected long delayNanos(long currentTimeNanos, long scheduledPurgeInterval)
Returns the amount of time left until the scheduled task with the closest dead line is executed.
-
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 whenEventExecutor.inEventLoop()
istrue
.
-
pollScheduledTask
protected final java.lang.Runnable pollScheduledTask()
- See Also:
pollScheduledTask(long)
-
fetchFromScheduledTaskQueue
protected boolean fetchFromScheduledTaskQueue(java.util.Queue<java.lang.Runnable> taskQueue)
Fetch scheduled tasks from the internal queue and add these to the givenQueue
.- Parameters:
taskQueue
- the task queue into which the fetched scheduled tasks should be transferred.- Returns:
true
if we were able to transfer everything,false
if we need to call this method again as soon as there is space again intaskQueue
.
-
pollScheduledTask
protected final java.lang.Runnable pollScheduledTask(long nanoTime)
Return theRunnable
which is ready to be executed with the givennanoTime
. You should usegetCurrentTimeNanos()
to retrieve the correctnanoTime
.
-
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()
Returnstrue
if a scheduled task is ready for processing.
-
schedule
public ScheduledFuture<?> schedule(java.lang.Runnable command, long delay, java.util.concurrent.TimeUnit unit)
- Specified by:
schedule
in interfaceEventExecutorGroup
- Specified by:
schedule
in interfacejava.util.concurrent.ScheduledExecutorService
- Overrides:
schedule
in classAbstractEventExecutor
-
schedule
public <V> ScheduledFuture<V> schedule(java.util.concurrent.Callable<V> callable, long delay, java.util.concurrent.TimeUnit unit)
- Specified by:
schedule
in interfaceEventExecutorGroup
- Specified by:
schedule
in interfacejava.util.concurrent.ScheduledExecutorService
- Overrides:
schedule
in classAbstractEventExecutor
-
scheduleAtFixedRate
public ScheduledFuture<?> scheduleAtFixedRate(java.lang.Runnable command, long initialDelay, long period, java.util.concurrent.TimeUnit unit)
- Specified by:
scheduleAtFixedRate
in interfaceEventExecutorGroup
- Specified by:
scheduleAtFixedRate
in interfacejava.util.concurrent.ScheduledExecutorService
- Overrides:
scheduleAtFixedRate
in classAbstractEventExecutor
-
scheduleWithFixedDelay
public ScheduledFuture<?> scheduleWithFixedDelay(java.lang.Runnable command, long initialDelay, long delay, java.util.concurrent.TimeUnit unit)
- Specified by:
scheduleWithFixedDelay
in interfaceEventExecutorGroup
- Specified by:
scheduleWithFixedDelay
in interfacejava.util.concurrent.ScheduledExecutorService
- Overrides:
scheduleWithFixedDelay
in classAbstractEventExecutor
-
validateScheduled
@Deprecated protected void validateScheduled(long amount, java.util.concurrent.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. Returnstrue
if theEventExecutor
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 theEventExecutor
thread if required.- Parameters:
deadlineNanos
- deadline of the to-be-scheduled task relative togetCurrentTimeNanos()
- Returns:
true
if theEventExecutor
thread should be woken,false
otherwise
-
afterScheduledTaskSubmitted
protected boolean afterScheduledTaskSubmitted(long deadlineNanos)
SeebeforeScheduledTaskSubmitted(long)
. Called only after that method returns false.- Parameters:
deadlineNanos
- relative togetCurrentTimeNanos()
- Returns:
true
if theEventExecutor
thread should be woken,false
otherwise
-
-