模块 wjybxx.commons.concurrent

程序包 cn.wjybxx.concurrent

类 DefaultFixedEventLoopGroup

java.lang.Object

cn.wjybxx.concurrent.AbstractEventLoopGroup

cn.wjybxx.concurrent.DefaultFixedEventLoopGroup

所有已实现的接口:

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

public class DefaultFixedEventLoopGroup
extends AbstractEventLoopGroup
implements FixedEventLoopGroup

作者:

wjybxx date 2023/4/8

构造器概要

构造器

构造器	说明
DefaultFixedEventLoopGroup(EventLoopGroupBuilder builder)

方法概要

修饰符和类型	方法	说明
boolean	awaitTermination(long timeout, TimeUnit unit)	等待EventLoopGroup进入终止状态 等同于在EventLoopGroup.terminationFuture()进行阻塞操作。
int	childCount()	EventLoop的数量。
void	forEach(Consumer<? super EventLoop> action)
protected void	invokeTerminationHook()	当所有的子节点都进入终结状态时，该方法将被调用 通常用于执行一些清理工作
boolean	isShutdown()	查询EventLoopGroup是否处于关闭状态。
boolean	isShuttingDown()	查询EventLoopGroup是否处于正在关闭状态。
boolean	isTerminated()	是否已进入终止状态，一旦进入终止状态，表示生命周期真正结束。
Iterator<EventLoop>	iterator()	注意；如果包含不定数量的EventLoop，返回的是快照。
EventLoop	select()	选择一个 EventLoop用于接下来的任务调度
EventLoop	select(int key)	通过一个键选择一个EventLoop 这提供了第二种绑定线程的方式，第一种方式是通过EventLoopGroup.select()分配一个线程，让业务对象持有EventLoop的引用。
void	shutdown()	请求关闭 ExecutorService，不再接收新的任务。
List<Runnable>	shutdownNow()	JDK文档： 请求关闭 ExecutorService，尝试取消所有正在执行的任务，停止所有待执行的任务，并不再接收新的任务。

从类继承的方法 cn.wjybxx.concurrent.AbstractEventLoopGroup

execute, execute, execute, execute, invokeAll, invokeAll, invokeAny, invokeAny, newPromise, schedule, schedule, schedule, scheduleAction, scheduleAtFixedRate, scheduleFunc, scheduleWithFixedDelay, submit, submit, submitAction, submitAction, submitAction, submitAction, submitFunc, submitFunc, submitFunc, submitFunc

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

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

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

close

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

execute, execute, execute, execute

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

invokeAll, invokeAll, invokeAny, invokeAny, newPromise, submit, submit, submit, submit, submitAction, submitAction, submitAction, submitAction, submitFunc, submitFunc, submitFunc, submitFunc

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

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

构造器详细资料

DefaultFixedEventLoopGroup

public DefaultFixedEventLoopGroup(EventLoopGroupBuilder builder)

方法详细资料

terminationFuture

public IFuture<?> terminationFuture()

从接口复制的说明: EventLoopGroup

返回等待线程终止的future。 返回的IFuture会在该Group管理的所有EventLoop终止后进入完成状态。

指定者:

terminationFuture 在接口中 EventLoopGroup

指定者:

terminationFuture 在接口中 IExecutorService

isShuttingDown

public boolean isShuttingDown()

从接口复制的说明: EventLoopGroup

查询EventLoopGroup是否处于正在关闭状态。 正在关闭状态下，拒绝接收新任务，当执行完所有任务后，进入关闭状态。

指定者:

isShuttingDown 在接口中 EventLoopGroup

指定者:

isShuttingDown 在接口中 IExecutorService

返回:

如果该EventLoopGroup管理的所有EventLoop正在关闭或已关闭则返回true

isShutdown

public boolean isShutdown()

从接口复制的说明: EventLoopGroup

查询EventLoopGroup是否处于关闭状态。 关闭状态下，拒绝接收新任务，执行退出前的清理操作，执行完清理操作后，进入终止状态。

指定者:

isShutdown 在接口中 EventLoopGroup

指定者:

isShutdown 在接口中 ExecutorService

指定者:

isShutdown 在接口中 IExecutorService

返回:

如果已关闭，则返回true

isTerminated

public boolean isTerminated()

从接口复制的说明: EventLoopGroup

是否已进入终止状态，一旦进入终止状态，表示生命周期真正结束。

指定者:

isTerminated 在接口中 EventLoopGroup

指定者:

isTerminated 在接口中 ExecutorService

指定者:

isTerminated 在接口中 IExecutorService

返回:

如果已处于终止状态，则返回true

awaitTermination

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

从接口复制的说明: EventLoopGroup

等待EventLoopGroup进入终止状态 等同于在EventLoopGroup.terminationFuture()进行阻塞操作。

指定者:

awaitTermination 在接口中 EventLoopGroup

指定者:

awaitTermination 在接口中 ExecutorService

指定者:

awaitTermination 在接口中 IExecutorService

参数:

timeout - 时间度量

unit - 事件单位

返回:

在方法返回前是否已进入终止状态

抛出:

InterruptedException - 如果在等待期间线程被中断，则抛出该异常。

shutdown

public void shutdown()

从接口复制的说明: EventLoopGroup

请求关闭 ExecutorService，不再接收新的任务。 ExecutorService在执行完现有任务后，进入关闭状态。 如果 ExecutorService 正在关闭，或已经关闭，则方法不产生任何效果。

该方法会立即返回，如果想等待 ExecutorService 进入终止状态， 可以使用EventLoopGroup.awaitTermination(long, TimeUnit)或EventLoopGroup.terminationFuture() 进行等待

指定者:

shutdown 在接口中 EventLoopGroup

指定者:

shutdown 在接口中 ExecutorService

指定者:

shutdown 在接口中 IExecutorService

shutdownNow

@Nonnull
public List<Runnable> shutdownNow()

从接口复制的说明: EventLoopGroup

JDK文档： 请求关闭 ExecutorService，尝试取消所有正在执行的任务，停止所有待执行的任务，并不再接收新的任务。 如果 ExecutorService 已经关闭，则方法不产生任何效果。

该方法会立即返回，如果想等待 ExecutorService 进入终止状态，可以使用IExecutorService.awaitTermination(long, TimeUnit) 或IExecutorService.terminationFuture() 进行等待。

在EventLoop架构下不保证标准的实现，只保证尽快的关闭。基于以下原因：

1. 可能无法安全的获取所有的任务(EventLoop架构属于多生产者单消费者模型，会尽量的避免其它线程消费数据)

2. 剩余任务数可能过多

指定者:

shutdownNow 在接口中 EventLoopGroup

指定者:

shutdownNow 在接口中 ExecutorService

指定者:

shutdownNow 在接口中 IExecutorService

返回:

may be empty。

invokeTerminationHook

protected void invokeTerminationHook()

当所有的子节点都进入终结状态时，该方法将被调用 通常用于执行一些清理工作

childCount

public int childCount()

从接口复制的说明: FixedEventLoopGroup

EventLoop的数量。

指定者:

childCount 在接口中 FixedEventLoopGroup

select

@Nonnull
public EventLoop select()

从接口复制的说明: EventLoopGroup

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

指定者:

select 在接口中 EventLoopGroup

select

@Nonnull
public EventLoop select(int key)

从接口复制的说明: FixedEventLoopGroup

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

指定者:

select 在接口中 FixedEventLoopGroup

参数:

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

iterator

@Nonnull
public Iterator<EventLoop> iterator()

从接口复制的说明: EventLoopGroup

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

指定者:

iterator 在接口中 EventLoopGroup

指定者:

iterator 在接口中 Iterable<EventLoop>

forEach

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

指定者:

forEach 在接口中 Iterable<EventLoop>

spliterator

public Spliterator<EventLoop> spliterator()

指定者:

spliterator 在接口中 Iterable<EventLoop>