ChannelGroup (Netty API Reference (4.1.22.Final))

All Superinterfaces:: java.util.Collection < Channel >，java.lang.Comparable < ChannelGroup >，java.lang.Iterable < Channel >，java.util.Set < Channel >

所有已知实现类：: DefaultChannelGroup

public interface ChannelGroup
extends java.util.Set<Channel>, java.lang.Comparable<ChannelGroup>

一个线程安全的Set ，包含开放Channel，并提供各种批量操作。使用ChannelGroup ，可以将Channel分类为有意义的组（例如，基于每个服务或每个状态）。关闭的Channel会自动从集合中删除，以便您不必担心生命周期添加Channel 。 A Channel可以属于多个ChannelGroup 。

将消息广播到多个`Channel`

如果您需要将消息广播到多个Channel ，则可以添加与收件人关联的Channel ，并呼叫write(Object) ：

  ChannelGroup recipients = new DefaultChannelGroup(GlobalEventExecutor.INSTANCE);
 recipients.add(channelA);
 recipients.add(channelB);
 ..
 recipients.write(Unpooled.copiedBuffer( "Service will shut down for maintenance in 5 minutes.", CharsetUtil.UTF_8));

通过`ChannelGroup`简化关闭过程

如果ServerChannel和ServerChannel都存在于同一个ChannelGroup中，则该组的任何所请求的I / O操作首先针对ServerChannel进行，然后针对其他针对ServerChannel进行。

当您关闭一台服务器时，此规则非常有用：

  ChannelGroup allChannels = new DefaultChannelGroup(GlobalEventExecutor.INSTANCE);

 public static void main(String[] args) throws Exception {
     ServerBootstrap b = new ServerBootstrap(..);
     ...
     b.childHandler(new MyHandler());

     // Start the server
     b.getPipeline().addLast("handler", new MyHandler());
     Channel serverChannel = b.bind(..).sync();
     allChannels.add(serverChannel);

     ... Wait until the shutdown signal reception ...

     // Close the serverChannel and then all accepted connections.
     allChannels.close().awaitUninterruptibly();
 }

 public class MyHandler extends ChannelInboundHandlerAdapter {
      @Override
     public void channelActive(ChannelHandlerContext ctx) {
         // closed on shutdown.
         allChannels.add(ctx.channel());
         super.channelActive(ctx);
     }
 }

方法摘要

所有方法接口方法抽象方法弃用的方法
Modifier and Type	Method and Description
`ChannelGroupFuture`	`close()` 关闭此组中的所有`Channel` 。
`ChannelGroupFuture`	`close(ChannelMatcher matcher)` 关闭所有`Channel` s此组由给定匹配的`ChannelMatcher` 。
`ChannelGroupFuture`	`deregister()` 已过时。该方法将在下一个主要功能版本中删除。注销所有`Channel` s该组中从他们`EventLoop` 。请注意，此操作是异步的，因为`ChannelOutboundInvoker.deregister()`是。
`ChannelGroupFuture`	`deregister(ChannelMatcher matcher)` 已过时。该方法将在下一个主要功能版本中删除。从`EventLoop`注销该组中的所有`Channel` s，它们与给定的`ChannelMatcher`相匹配。请注意，此操作是异步的，因为`ChannelOutboundInvoker.deregister()`是。
`ChannelGroupFuture`	`disconnect()` 将该组中的所有`Channel`从远程对等端断开。
`ChannelGroupFuture`	`disconnect(ChannelMatcher matcher)` 将该组中的所有`Channel`与远程对等设备断开连接，并与给定的`ChannelMatcher`匹配。
`Channel`	`find(ChannelId id)` 返回`Channel`其中有指定的`ChannelId` 。
`ChannelGroup`	`flush()` 冲洗此组中的所有`Channel` 。
`ChannelGroup`	`flush(ChannelMatcher matcher)` 冲洗该组中的所有`Channel` s，它们与给定的`ChannelMatcher`相匹配。
`ChannelGroupFuture`	`flushAndWrite(java.lang.Object message)` 已过时。改为使用`writeAndFlush(Object)` 。
`ChannelGroupFuture`	`flushAndWrite(java.lang.Object message, ChannelMatcher matcher)` 已过时。改为使用`writeAndFlush(Object, ChannelMatcher)` 。
`java.lang.String`	`name()` 返回此组的名称。
`ChannelGroupFuture`	`newCloseFuture()` 返回`ChannelGroupFuture`当所有这一切将被通知`Channel`个 S中的这部分`ChannelGroup` ，在调用的时候，被关闭。
`ChannelGroupFuture`	`newCloseFuture(ChannelMatcher matcher)` 返回`ChannelGroupFuture` ，当呼叫时，所有属于此`ChannelGroup`的`Channel`都关闭时，将会收到通知。
`ChannelGroupFuture`	`write(java.lang.Object message)` 将指定的`message`写入该组中的所有`Channel` 。
`ChannelGroupFuture`	`write(java.lang.Object message, ChannelMatcher matcher)` 将指定的`message`所有`Channel` s此组由给定的匹配`ChannelMatcher` 。
`ChannelGroupFuture`	`write(java.lang.Object message, ChannelMatcher matcher, boolean voidPromise)` 将指定的`message`所有`Channel` s此组由给定的匹配`ChannelMatcher` 。
`ChannelGroupFuture`	`writeAndFlush(java.lang.Object message)` 拨打 `write(Object)`和 `flush()`的快捷方式。
`ChannelGroupFuture`	`writeAndFlush(java.lang.Object message, ChannelMatcher matcher)` 用于拨打`write(Object)`和`flush()`的快捷方式，仅适用于与`ChannelMatcher`匹配的`Channel` 。
`ChannelGroupFuture`	`writeAndFlush(java.lang.Object message, ChannelMatcher matcher, boolean voidPromise)` 用于拨打`write(Object, ChannelMatcher, boolean)`和`flush()`的快捷方式，仅适用于与`ChannelMatcher`匹配的`Channel` 。

Methods inherited from interface java.util.Set
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

Methods inherited from interface java.lang.Comparable
compareTo

- 方法详细信息
  - name
```
java.lang.String name()
```
    返回此组的名称。团体名称纯粹是为了帮助您将一个团体与其他团体区分开来。
  - find
```
Channel find(ChannelId id)
```
    返回Channel其中有指定的ChannelId 。
    
    结果
    
    匹配Channel如果找到。 null否则。
  - write
```
ChannelGroupFuture write(java.lang.Object message)
```
    将指定的message写入此组中的所有Channel 。如果指定的message是一个实例ByteBuf ，它会自动为duplicated ，以避免出现竞争状况。 ByteBufHolder也是如此。请注意，此操作是异步的，因为ChannelOutboundInvoker.write(Object)是。
    
    结果
    
    本身
  - write
```
ChannelGroupFuture write(java.lang.Object message,
                         ChannelMatcher matcher)
```
    将指定的message所有Channel s此组由给定的匹配ChannelMatcher 。如果指定的message是message的实例，则会自动为duplicated来避免竞争状况。 ByteBufHolder也是如此。请注意，此操作是异步的，因为ChannelOutboundInvoker.write(Object)是。
    
    结果
    
    ChannelGroupFuture实例通知所有通道何时完成操作
  - write
```
ChannelGroupFuture write(java.lang.Object message,
                         ChannelMatcher matcher,
                         boolean voidPromise)
```
    将指定的message所有Channel s此组由给定的匹配ChannelMatcher 。如果指定的message是message的一个实例，则会自动为duplicated避免竞争状况。 ByteBufHolder也是如此。请注意，此操作是异步的，因为ChannelOutboundInvoker.write(Object)是。如果voidPromise是true ChannelOutboundInvoker.voidPromise()用于写入，因此对返回的ChannelGroupFuture的相同限制适用于无效承诺。
    
    结果
    
    通知所有通道何时完成操作的ChannelGroupFuture实例
  - flush
```
ChannelGroup flush()
```
    冲洗此组中的所有Channel 。如果指定的messages是一个实例ByteBuf ，它会自动为duplicated ，以避免出现竞争状况。请注意，此操作是异步的，因为ChannelOutboundInvoker.write(Object)是。
    
    结果
    
    ChannelGroupFuture实例通知所有通道何时完成操作
  - flush
```
ChannelGroup flush(ChannelMatcher matcher)
```
    刷新所有Channel s此组由给定匹配的ChannelMatcher 。如果指定的messages是一个实例ByteBuf ，它会自动为duplicated ，以避免出现竞争状况。请注意，此操作是异步的，因为ChannelOutboundInvoker.write(Object)是。
    
    结果
    
    ChannelGroupFuture实例通知所有通道何时完成操作
  - writeAndFlush
```
ChannelGroupFuture writeAndFlush(java.lang.Object message)
```
    快捷方式拨打 write(Object)和 flush() 。
  - flushAndWrite
```
@Deprecated
ChannelGroupFuture flushAndWrite(java.lang.Object message)
```
    已过时。改为使用writeAndFlush(Object) 。
  - writeAndFlush
```
ChannelGroupFuture writeAndFlush(java.lang.Object message,
                                 ChannelMatcher matcher)
```
    用于拨打write(Object)和flush()的快捷方式，仅适用于与ChannelMatcher匹配的Channel 。
  - writeAndFlush
```
ChannelGroupFuture writeAndFlush(java.lang.Object message,
                                 ChannelMatcher matcher,
                                 boolean voidPromise)
```
    拨打write(Object, ChannelMatcher, boolean)和flush()的快捷方式，仅适用于与ChannelMatcher匹配的Channel 。
  - flushAndWrite
```
@Deprecated
ChannelGroupFuture flushAndWrite(java.lang.Object message,
                                             ChannelMatcher matcher)
```
    已过时。改为使用writeAndFlush(Object, ChannelMatcher) 。
  - disconnect
```
ChannelGroupFuture disconnect()
```
    断开此组中所有Channel与远程对等方的连接。
    
    结果
    
    通知所有通道何时完成操作的ChannelGroupFuture实例
  - disconnect
```
ChannelGroupFuture disconnect(ChannelMatcher matcher)
```
    将该组中的所有Channel与远程对等设备断开连接，并与给定的ChannelMatcher相匹配。
    
    结果
    
    ChannelGroupFuture实例通知所有通道何时完成操作
  - close
```
ChannelGroupFuture close()
```
    关闭此组中的所有Channel 。如果Channel连接到远程对等端或绑定到本地地址，则会自动断开连接并解除绑定。
    
    结果
    
    ChannelGroupFuture实例通知所有通道何时完成操作
  - close
```
ChannelGroupFuture close(ChannelMatcher matcher)
```
    关闭所有Channel s此组由给定匹配的ChannelMatcher 。如果Channel连接到远程对等端或绑定到本地地址，它将自动断开连接并解除绑定。
    
    结果
    
    ChannelGroupFuture实例通知所有通道何时完成操作
  - deregister
```
@Deprecated
ChannelGroupFuture deregister()
```
    已过时。该方法将在下一个主要功能版本中删除。从EventLoop注销该组中的所有Channel s。请注意，此操作是异步的，因为ChannelOutboundInvoker.deregister()是。
    
    结果
    
    ChannelGroupFuture实例通知所有通道何时完成操作
  - deregister
```
@Deprecated
ChannelGroupFuture deregister(ChannelMatcher matcher)
```
    已过时。该方法将在下一个主要功能版本中删除。从EventLoop注销该组中的所有Channel ，它们与给定的ChannelMatcher相匹配。请注意，此操作是异步的，因为ChannelOutboundInvoker.deregister()是。
    
    结果
    
    ChannelGroupFuture实例通知所有通道何时完成操作
  - newCloseFuture
```
ChannelGroupFuture newCloseFuture()
```
    返回ChannelGroupFuture当所有这一切将被通知Channel个 S中的这部分ChannelGroup ，在调用的时候，被关闭。
  - newCloseFuture
```
ChannelGroupFuture newCloseFuture(ChannelMatcher matcher)
```
    返回ChannelGroupFuture ，当呼叫时ChannelGroup中的所有Channel都关闭时，将会通知该ChannelGroupFuture 。

Interface ChannelGroup

将消息广播到多个Channel

通过ChannelGroup简化关闭过程

方法摘要

Methods inherited from interface java.util.Set

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Methods inherited from interface java.lang.Comparable

方法详细信息

name

find

write

write

write

flush

flush

writeAndFlush

flushAndWrite

writeAndFlush

writeAndFlush

flushAndWrite

disconnect

disconnect

close

close

deregister

deregister

newCloseFuture

newCloseFuture

将消息广播到多个`Channel`

通过`ChannelGroup`简化关闭过程