io.netty.channel

Class SingleThreadEventExecutor

java.lang.Object

java.util.concurrent.AbstractExecutorService

io.netty.channel.SingleThreadEventExecutor

All Implemented Interfaces:

EventExecutor, EventExecutorGroup, Executor, ExecutorService, ScheduledExecutorService

Direct Known Subclasses:

SingleThreadEventLoop

public abstract class SingleThreadEventExecutor
extends AbstractExecutorService
implements EventExecutor

Abstract base class for EventExecutor's that execute all its submitted tasks in a single thread.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SingleThreadEventExecutor(EventExecutorGroup parent, ThreadFactory threadFactory, ChannelTaskScheduler scheduler)

Method Summary

Methods

Modifier and Type	Method and Description
void	addShutdownHook(Runnable task)
protected void	addTask(Runnable task)
boolean	awaitTermination(long timeout, TimeUnit unit) Waits until EventExecutorGroup.isTerminated() returns true or the specified amount of time passes.
protected void	cleanup()
static SingleThreadEventExecutor	currentEventLoop()
void	execute(Runnable task)
protected boolean	hasTasks()
boolean	inEventLoop() Calls EventExecutor.inEventLoop(Thread) with Thread.currentThread() as argument
boolean	inEventLoop(Thread thread) Return true if the given Thread is executed in the event loop, false otherwise.
protected void	interruptThread()
boolean	isShutdown() Returns true if and only if EventExecutorGroup.shutdown() has been called.
boolean	isTerminated() Returns true if and only if EventExecutorGroup.shutdown() has been called and all EventExecutors managed by this group has been terminated completely.
protected Queue<Runnable>	newTaskQueue()
EventExecutor	next() Returns a reference to itself.
EventExecutorGroup	parent() Return the EventExecutorGroup which is the parent of this EventExecutor, or null if it has no parent
protected Runnable	peekTask()
protected Runnable	pollTask()
void	removeShutdownHook(Runnable task)
protected boolean	removeTask(Runnable task)
protected abstract void	run()
protected boolean	runAllTasks()
<V> ScheduledFuture<V>	schedule(Callable<V> callable, long delay, TimeUnit unit)
ScheduledFuture<?>	schedule(Runnable command, long delay, TimeUnit unit)
ScheduledFuture<?>	scheduleAtFixedRate(Runnable command, long initialDelay, long period, TimeUnit unit)
ScheduledFuture<?>	scheduleWithFixedDelay(Runnable command, long initialDelay, long delay, TimeUnit unit)
void	shutdown() Shuts down all EventExecutors managed by this group.
List<Runnable>	shutdownNow()
protected Runnable	takeTask()
protected abstract void	wakeup(boolean inEventLoop)

Methods inherited from class java.util.concurrent.AbstractExecutorService

invokeAll, invokeAll, invokeAny, invokeAny, newTaskFor, newTaskFor, submit, submit, submit

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.concurrent.ExecutorService

invokeAll, invokeAll, invokeAny, invokeAny, submit, submit, submit

Constructor Detail

SingleThreadEventExecutor

protected SingleThreadEventExecutor(EventExecutorGroup parent,
                         ThreadFactory threadFactory,
                         ChannelTaskScheduler scheduler)

Method Detail

currentEventLoop

public static SingleThreadEventExecutor currentEventLoop()

newTaskQueue

protected Queue<Runnable> newTaskQueue()

parent

public EventExecutorGroup parent()

Description copied from interface: EventExecutor

Return the EventExecutorGroup which is the parent of this EventExecutor, or null if it has no parent

Specified by:

parent in interface EventExecutor

next

public EventExecutor next()

Description copied from interface: EventExecutor

Returns a reference to itself.

Specified by:

next in interface EventExecutor

Specified by:

next in interface EventExecutorGroup

interruptThread

protected void interruptThread()

pollTask

protected Runnable pollTask()

takeTask

protected Runnable takeTask()
                     throws InterruptedException

Throws:

InterruptedException

peekTask

protected Runnable peekTask()

hasTasks

protected boolean hasTasks()

addTask

protected void addTask(Runnable task)

removeTask

protected boolean removeTask(Runnable task)

runAllTasks

protected boolean runAllTasks()

run

protected abstract void run()

cleanup

protected void cleanup()

wakeup

protected abstract void wakeup(boolean inEventLoop)

inEventLoop

public boolean inEventLoop()

Description copied from interface: EventExecutor

Calls EventExecutor.inEventLoop(Thread) with Thread.currentThread() as argument

Specified by:

inEventLoop in interface EventExecutor

inEventLoop

public boolean inEventLoop(Thread thread)

Description copied from interface: EventExecutor

Return true if the given Thread is executed in the event loop, false otherwise.

Specified by:

inEventLoop in interface EventExecutor

addShutdownHook

public void addShutdownHook(Runnable task)

removeShutdownHook

public void removeShutdownHook(Runnable task)

shutdown

public void shutdown()

Description copied from interface: EventExecutorGroup

Shuts down all EventExecutors managed by this group.

Specified by:

shutdown in interface EventExecutorGroup

Specified by:

shutdown in interface ExecutorService

See Also:

ExecutorService.shutdown()

shutdownNow

public List<Runnable> shutdownNow()

Specified by:

shutdownNow in interface ExecutorService

isShutdown

public boolean isShutdown()

Description copied from interface: EventExecutorGroup

Returns true if and only if EventExecutorGroup.shutdown() has been called.

Specified by:

isShutdown in interface EventExecutorGroup

Specified by:

isShutdown in interface ExecutorService

See Also:

ExecutorService.isShutdown()

isTerminated

public boolean isTerminated()

Description copied from interface: EventExecutorGroup

Returns true if and only if EventExecutorGroup.shutdown() has been called and all EventExecutors managed by this group has been terminated completely.

Specified by:

isTerminated in interface EventExecutorGroup

Specified by:

isTerminated in interface ExecutorService

See Also:

ExecutorService.isTerminated()

awaitTermination

public boolean awaitTermination(long timeout,
                       TimeUnit unit)
                         throws InterruptedException

Description copied from interface: EventExecutorGroup

Waits until EventExecutorGroup.isTerminated() returns true or the specified amount of time passes.

Specified by:

awaitTermination in interface EventExecutorGroup

Specified by:

awaitTermination in interface ExecutorService

Throws:

InterruptedException

See Also:

ExecutorService.awaitTermination(long, TimeUnit)

execute

public void execute(Runnable task)

Specified by:

execute in interface Executor

schedule

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

Specified by:

schedule in interface ScheduledExecutorService

schedule

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

Specified by:

schedule in interface ScheduledExecutorService

scheduleAtFixedRate

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

Specified by:

scheduleAtFixedRate in interface ScheduledExecutorService

scheduleWithFixedDelay

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

Specified by:

scheduleWithFixedDelay in interface ScheduledExecutorService