模块 wjybxx.commons.concurrent

程序包 cn.wjybxx.concurrent

类 AbstractEventLoop

java.lang.Object

cn.wjybxx.concurrent.AbstractEventLoop

所有已实现的接口:

EventLoop, EventLoopGroup, FixedEventLoopGroup, IExecutor, IExecutorService, IScheduledExecutorService, SingleThreadExecutor, AutoCloseable, Iterable<EventLoop>, Executor, ExecutorService, ScheduledExecutorService

直接已知子类:

DisruptorEventLoop

public abstract class AbstractEventLoop
extends Object
implements EventLoop

作者:

wjybxx date 2023/4/7

字段概要

字段

修饰符和类型	字段	说明
protected static final org.slf4j.Logger	logger
protected final EventLoopGroup	parent
protected final Collection<EventLoop>	selfCollection

构造器概要

构造器

限定符	构造器	说明
protected	AbstractEventLoop(EventLoopGroup parent)

方法概要

修饰符和类型	方法	说明
int	childCount()	EventLoop的数量。
final void	ensureInEventLoop()
final void	ensureInEventLoop(String method)
abstract void	execute(Runnable command)	在将来的某个时间执行给定的命令。
void	execute(Runnable command, int options)	在将来的某个时间执行给定的命令。
void	execute(Consumer<? super IContext> action, IContext ctx)	Consumer和Runnable的lambda差异足够大，因此选择重载。
void	execute(Consumer<? super IContext> action, IContext ctx, int options)
final void	forEach(Consumer<? super EventLoop> action)
<T> List<Future<T>>	invokeAll(Collection<? extends Callable<T>> tasks)
<T> List<Future<T>>	invokeAll(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit)
<T> T	invokeAny(Collection<? extends Callable<T>> tasks)
<T> T	invokeAny(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit)
final Iterator<EventLoop>	iterator()	注意；如果包含不定数量的EventLoop，返回的是快照。
protected static void	logCause(Throwable t)
<T> IPromise<T>	newPromise()	创建一个promise以用于任务调度 如果当前Executor是SingleThreadExecutor，返回的future将禁止在当前EventLoop上执行阻塞操作。
EventLoopGroup	parent()	返回该EventLoop线程所在的线程组（管理该EventLoop的容器）。
EventLoop	select()	选择一个 EventLoop用于接下来的任务调度
EventLoop	select(int key)	通过一个键选择一个EventLoop 这提供了第二种绑定线程的方式，第一种方式是通过EventLoopGroup.select()分配一个线程，让业务对象持有EventLoop的引用。
final Spliterator<EventLoop>	spliterator()
<T> IFuture<T>	submit(TaskBuilder<T> builder)
<T> IFuture<T>	submit(Callable<T> task)
IFuture<?>	submitAction(Runnable task)
IFuture<?>	submitAction(Runnable task, int options)	该方法可能和ExecutorService.submit(Runnable, Object)冲突，因此我们要带后缀
IFuture<?>	submitAction(Consumer<? super IContext> task, IContext ctx)
IFuture<?>	submitAction(Consumer<? super IContext> task, IContext ctx, int options)
<V> IFuture<V>	submitFunc(Callable<? extends V> task)
<V> IFuture<V>	submitFunc(Callable<? extends V> task, int options)
<V> IFuture<V>	submitFunc(Function<? super IContext,? extends V> task, IContext ctx)
<V> IFuture<V>	submitFunc(Function<? super IContext,? extends V> task, IContext ctx, int options)
final void	throwIfInEventLoop(String method)

从类继承的方法 java.lang.Object

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

从接口继承的方法 cn.wjybxx.concurrent.EventLoop

inEventLoop, inEventLoop, isRunning, mainModule, runningFuture, start, state, wakeup

从接口继承的方法 cn.wjybxx.concurrent.EventLoopGroup

awaitTermination, isShutdown, isShuttingDown, isTerminated, shutdown, shutdownNow, terminationFuture

从接口继承的方法 java.util.concurrent.ExecutorService

close

从接口继承的方法 cn.wjybxx.concurrent.IExecutorService

submit, submit

从接口继承的方法 cn.wjybxx.concurrent.IScheduledExecutorService

newScheduledPromise, schedule, schedule, schedule, scheduleAction, scheduleAtFixedRate, scheduleFunc, scheduleWithFixedDelay

字段详细资料

logger

protected static final org.slf4j.Logger logger

parent

protected final EventLoopGroup parent

selfCollection

protected final Collection<EventLoop> selfCollection

构造器详细资料

AbstractEventLoop

protected AbstractEventLoop(@Nullable
 EventLoopGroup parent)

方法详细资料

execute

public abstract void execute(Runnable command)

从接口复制的说明: IExecutor

在将来的某个时间执行给定的命令。 命令可以在新线程中执行，也可以在池线程中执行，或者在调用线程中执行，这由Executor实现决定。 Executor.execute(Runnable)

指定者:

execute 在接口中 Executor

指定者:

execute 在接口中 IExecutor

参数:

command - 要执行的任务，注意ITask类型

execute

public void execute(Runnable command,
 int options)

从接口复制的说明: IExecutor

在将来的某个时间执行给定的命令。 命令可以在新线程中执行，也可以在池线程中执行，或者在调用线程中执行，这由Executor实现决定。 Executor.execute(Runnable)

任务的调度特征值 1.Executor需要感知用户任务的一些属性，以实现更好的管理。 2.选项可参考TaskOption。 3.该接口不应该测试任务的类型，应当以参数的options为准。

指定者:

execute 在接口中 IExecutor

参数:

command - 要执行的任务

options - 任务的调度特征值，见TaskOption

execute

public void execute(Consumer<? super IContext> action,
 IContext ctx)

从接口复制的说明: IExecutor

Consumer和Runnable的lambda差异足够大，因此选择重载。

指定者:

execute 在接口中 IExecutor

参数:

action - 要执行的任务

ctx - 任务绑定的上下文

execute

public void execute(Consumer<? super IContext> action,
 IContext ctx,
 int options)

指定者:

execute 在接口中 IExecutor

parent

@Nullable
public EventLoopGroup parent()

从接口复制的说明: EventLoop

返回该EventLoop线程所在的线程组（管理该EventLoop的容器）。 如果没有父节点，返回null。

指定者:

parent 在接口中 EventLoop

select

@Nonnull
public EventLoop select()

从接口复制的说明: EventLoopGroup

选择一个 EventLoop用于接下来的任务调度

指定者:

select 在接口中 EventLoop

指定者:

select 在接口中 EventLoopGroup

返回:

this - 由于EventLoop表示单个线程，因此总是分配自己。

select

@Nonnull
public EventLoop select(int key)

从接口复制的说明: FixedEventLoopGroup

通过一个键选择一个EventLoop 这提供了第二种绑定线程的方式，第一种方式是通过EventLoopGroup.select()分配一个线程，让业务对象持有EventLoop的引用。 现在，你可以为用户分配一个键，通过键建立虚拟绑定。

指定者:

select 在接口中 EventLoop

指定者:

select 在接口中 FixedEventLoopGroup

参数:

key - 计算索引的键；限定int可保证选择性能

返回:

this - 由于EventLoop表示单个线程，因此总是选中自己

childCount

public int childCount()

从接口复制的说明: FixedEventLoopGroup

EventLoop的数量。

指定者:

childCount 在接口中 FixedEventLoopGroup

ensureInEventLoop

public final void ensureInEventLoop()

指定者:

ensureInEventLoop 在接口中 EventLoop

ensureInEventLoop

public final void ensureInEventLoop(String method)

指定者:

ensureInEventLoop 在接口中 EventLoop

throwIfInEventLoop

public final void throwIfInEventLoop(String method)

newPromise

public <T> IPromise<T> newPromise()

从接口复制的说明: IExecutorService

创建一个promise以用于任务调度 如果当前Executor是SingleThreadExecutor，返回的future将禁止在当前EventLoop上执行阻塞操作。

指定者:

newPromise 在接口中 IExecutorService

submit

public <T> IFuture<T> submit(@Nonnull
 TaskBuilder<T> builder)

指定者:

submit 在接口中 IExecutorService

submit

public <T> IFuture<T> submit(Callable<T> task)

指定者:

submit 在接口中 ExecutorService

指定者:

submit 在接口中 IExecutorService

submitFunc

public <V> IFuture<V> submitFunc(Callable<? extends V> task)

指定者:

submitFunc 在接口中 IExecutorService

submitFunc

public <V> IFuture<V> submitFunc(Callable<? extends V> task,
 int options)

指定者:

submitFunc 在接口中 IExecutorService

submitFunc

public <V> IFuture<V> submitFunc(Function<? super IContext,? extends V> task,
 IContext ctx)

指定者:

submitFunc 在接口中 IExecutorService

submitFunc

public <V> IFuture<V> submitFunc(Function<? super IContext,? extends V> task,
 IContext ctx,
 int options)

指定者:

submitFunc 在接口中 IExecutorService

submitAction

public IFuture<?> submitAction(Runnable task)

指定者:

submitAction 在接口中 IExecutorService

submitAction

public IFuture<?> submitAction(Runnable task,
 int options)

该方法可能和ExecutorService.submit(Runnable, Object)冲突，因此我们要带后缀

指定者:

submitAction 在接口中 IExecutorService

submitAction

public IFuture<?> submitAction(Consumer<? super IContext> task,
 IContext ctx)

指定者:

submitAction 在接口中 IExecutorService

submitAction

public IFuture<?> submitAction(Consumer<? super IContext> task,
 IContext ctx,
 int options)

指定者:

submitAction 在接口中 IExecutorService

invokeAny

@Nonnull
public <T> T invokeAny(Collection<? extends Callable<T>> tasks)
                throws InterruptedException,
ExecutionException

指定者:

invokeAny 在接口中 ExecutorService

指定者:

invokeAny 在接口中 IExecutorService

抛出:

InterruptedException

ExecutionException

invokeAny

public <T> T invokeAny(Collection<? extends Callable<T>> tasks,
 long timeout,
 TimeUnit unit)
                throws InterruptedException,
ExecutionException,
TimeoutException

指定者:

invokeAny 在接口中 ExecutorService

指定者:

invokeAny 在接口中 IExecutorService

抛出:

InterruptedException

ExecutionException

TimeoutException

invokeAll

@Nonnull
public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks)
                              throws InterruptedException

指定者:

invokeAll 在接口中 ExecutorService

指定者:

invokeAll 在接口中 IExecutorService

抛出:

InterruptedException

invokeAll

@Nonnull
public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks,
 long timeout,
 TimeUnit unit)
                              throws InterruptedException

指定者:

invokeAll 在接口中 ExecutorService

指定者:

invokeAll 在接口中 IExecutorService

抛出:

InterruptedException

iterator

@Nonnull
public final Iterator<EventLoop> iterator()

从接口复制的说明: EventLoopGroup

注意；如果包含不定数量的EventLoop，返回的是快照。

指定者:

iterator 在接口中 EventLoopGroup

指定者:

iterator 在接口中 Iterable<EventLoop>

forEach

public final void forEach(Consumer<? super EventLoop> action)

指定者:

forEach 在接口中 Iterable<EventLoop>

spliterator

public final Spliterator<EventLoop> spliterator()

指定者:

spliterator 在接口中 Iterable<EventLoop>

logCause

protected static void logCause(Throwable t)