ChannelHandlerContext (Netty API Reference (4.1.22.Final))

All Superinterfaces:

AttributeMap ， ChannelInboundInvoker ， ChannelOutboundInvoker
```
public interface ChannelHandlerContext
extends AttributeMap, ChannelInboundInvoker, ChannelOutboundInvoker
```
使ChannelHandler能够与其ChannelPipeline和其他处理程序进行交互。在其他方面的处理程序可以通知下一个ChannelHandler在ChannelPipeline以及修改ChannelPipeline它属于动态。
通知
您可以通过调用此处提供的各种方法之一来通知同一个ChannelPipeline中最接近的处理程序。请参阅ChannelPipeline以了解事件如何流动。
修改管道
你可以得到ChannelPipeline致电处理器属于pipeline() 。一个非平凡的应用程序可以在运行时动态地插入，移除或替换管道中的处理程序。
检索以备后用
您可以保留ChannelHandlerContext供以后使用，例如触发处理程序方法之外的事件，即使是从其他线程触发。
```
  public class MyHandler extends ChannelDuplexHandler {

     private ChannelHandlerContext ctx;

     public void beforeAdd(ChannelHandlerContext ctx) {
         this.ctx = ctx;
     }

     public void login(String username, password) {
         ctx.write(new LoginMessage(username, password));
     }
     ...
 } 
```
存储有状态的信息
attr(AttributeKey)允许您存储和访问与处理程序及其上下文相关的有状态信息。请参阅ChannelHandler了解各种推荐的管理有状态信息的方法。
处理程序可以有多个上下文
请注意，一个ChannelHandler实例可以添加到多个ChannelPipeline 。这意味着一个ChannelHandler实例可以有多个ChannelHandlerContext ，因此如果一个实例可以多次添加到一个或多个ChannelPipeline ，则可以使用不同的ChannelHandlerContext调用单个实例。
例如，以下处理程序将具有与添加到管道的次数相同的多个独立AttributeKey ，而不管它是多次添加到同一管道还是多次添加到不同管道：
```
  public class FactorialHandler extends ChannelInboundHandlerAdapter {

   private final AttributeKey<Integer> counter = AttributeKey.valueOf("counter");

   // This handler will receive a sequence of increasing integers starting
   // from 1.
    @Override
   public void channelRead(ChannelHandlerContext ctx, Object msg) {
     Integer a = ctx.attr(counter).get();

     if (a == null) {
       a = 1;
     }

     attr.set(a * (Integer) msg);
   }
 }

 // Different context objects are given to "f1", "f2", "f3", and "f4" even if
 // they refer to the same handler instance.  Because the FactorialHandler
 // stores its state in a context object (using an AttributeKey), the factorial is
 // calculated correctly 4 times once the two pipelines (p1 and p2) are active.
 FactorialHandler fh = new FactorialHandler();

 ChannelPipeline p1 = Channels.pipeline();
 p1.addLast("f1", fh);
 p1.addLast("f2", fh);

 ChannelPipeline p2 = Channels.pipeline();
 p2.addLast("f3", fh);
 p2.addLast("f4", fh); 
```
值得阅读的额外资源

请参阅ChannelHandler和ChannelPipeline，以了解有关入站和出站操作的更多信息，它们具有哪些基本差异，它们如何在流水线中流动以及如何处理应用程序中的操作。

方法摘要

所有方法接口方法抽象方法弃用的方法
Modifier and Type	Method and Description
`ByteBufAllocator`	`alloc()` 返回分配的`ByteBufAllocator`这将被用于分配`ByteBuf`秒。
`<T> Attribute<T>`	`attr(AttributeKey<T> key)` 已过时。使用`AttributeMap.attr(AttributeKey)`
`Channel`	`channel()` 返回`Channel`其绑定到`ChannelHandlerContext` 。
`EventExecutor`	`executor()` 返回用于执行任意任务的`EventExecutor` 。
`ChannelHandlerContext`	`fireChannelActive()` A `Channel`现在处于活动状态，这意味着它已连接。
`ChannelHandlerContext`	`fireChannelInactive()` A `Channel`现在不活动，这意味着它已关闭。
`ChannelHandlerContext`	`fireChannelRead(java.lang.Object msg)` A `Channel`收到消息。
`ChannelHandlerContext`	`fireChannelReadComplete()` 触发`ChannelInboundHandler.channelReadComplete(ChannelHandlerContext)`事件到下一个`ChannelInboundHandler`在`ChannelPipeline` 。
`ChannelHandlerContext`	`fireChannelRegistered()` A `Channel`已注册到其`EventLoop` 。
`ChannelHandlerContext`	`fireChannelUnregistered()` A `Channel`从其`EventLoop`未注册。
`ChannelHandlerContext`	`fireChannelWritabilityChanged()` 触发`ChannelInboundHandler.channelWritabilityChanged(ChannelHandlerContext)`事件到下一个`ChannelInboundHandler`在`ChannelPipeline` 。
`ChannelHandlerContext`	`fireExceptionCaught(java.lang.Throwable cause)` A `Channel`在其一项入境业务中收到`Throwable` 。
`ChannelHandlerContext`	`fireUserEventTriggered(java.lang.Object evt)` A `Channel`收到用户定义的事件。
`ChannelHandlerContext`	`flush()` 请求通过此ChannelOutboundInvoker清除所有未决消息。
`ChannelHandler`	`handler()` `ChannelHandler`这是绑定此`ChannelHandlerContext` 。
`<T> boolean`	`hasAttr(AttributeKey<T> key)` 已过时。使用`AttributeMap.hasAttr(AttributeKey)`
`boolean`	`isRemoved()` 返回`true`如果`ChannelHandler`属于这种情况下从取出`ChannelPipeline` 。
`java.lang.String`	`name()` `ChannelHandlerContext`的唯一名称。当`ChannelHandler`被添加到`ChannelPipeline`时使用该名称。
`ChannelPipeline`	`pipeline()` 返回分配的`ChannelPipeline`
`ChannelHandlerContext`	`read()` 请求来读取数据`Channel`进入第一入缓冲区，触发`ChannelInboundHandler.channelRead(ChannelHandlerContext, Object)`如果数据读取事件，并触发`channelReadComplete`事件，这样的处理可以决定继续读书。

Methods inherited from interface io.netty.channel.ChannelOutboundInvoker
bind, bind, close, close, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, voidPromise, write, write, writeAndFlush, writeAndFlush

- 方法详细信息
  - channel
```
Channel channel()
```
    返回Channel其绑定到ChannelHandlerContext 。
  - executor
```
EventExecutor executor()
```
    返回用于执行任意任务的EventExecutor 。
  - name
```
java.lang.String name()
```
    ChannelHandlerContext的唯一名称。当ChannelHandler被添加到ChannelPipeline时使用该名称。该名称也可用于访问ChannelHandler中的注册ChannelHandler 。
  - handler
```
ChannelHandler handler()
```
    ChannelHandler这是绑定此ChannelHandlerContext 。
  - isRemoved
```
boolean isRemoved()
```
    返回true如果ChannelHandler属于这种情况下从取出ChannelPipeline 。请注意，此方法仅用于在EventLoop中使用。
  - fireChannelRegistered
```
ChannelHandlerContext fireChannelRegistered()
```
    从接口ChannelInboundInvoker复制的描述
    
    A Channel已注册到其EventLoop 。这将导致在具有ChannelInboundHandler.channelRegistered(ChannelHandlerContext)方法称为下一个的ChannelInboundHandler包含在ChannelPipeline的的Channel 。
    
    Specified by:
    
    fireChannelRegistered在界面 ChannelInboundInvoker
  - fireChannelUnregistered
```
ChannelHandlerContext fireChannelUnregistered()
```
    从界面复制的描述： ChannelInboundInvoker
    
    A Channel从其EventLoop未注册。这将导致在具有ChannelInboundHandler.channelUnregistered(ChannelHandlerContext)方法称为下一个的ChannelInboundHandler包含在ChannelPipeline的的Channel 。
    
    Specified by:
    
    fireChannelUnregistered接口 ChannelInboundInvoker
  - fireChannelActive
```
ChannelHandlerContext fireChannelActive()
```
    从接口ChannelInboundInvoker复制的描述
    
    A Channel现在处于活动状态，这意味着它已连接。这将导致在具有ChannelInboundHandler.channelActive(ChannelHandlerContext)方法称为下一个的ChannelInboundHandler包含在ChannelPipeline的的Channel 。
    
    Specified by:
    
    fireChannelActive接口 ChannelInboundInvoker
  - fireChannelInactive
```
ChannelHandlerContext fireChannelInactive()
```
    从界面复制的描述： ChannelInboundInvoker
    
    A Channel现在不活动，这意味着它已关闭。这将导致在具有ChannelInboundHandler.channelInactive(ChannelHandlerContext)方法称为下一个的ChannelInboundHandler包含在ChannelPipeline的的Channel 。
    
    Specified by:
    
    fireChannelInactive在界面 ChannelInboundInvoker
  - fireExceptionCaught
```
ChannelHandlerContext fireExceptionCaught(java.lang.Throwable cause)
```
    从接口ChannelInboundInvoker复制的描述
    
    A Channel在其一项入境业务中收到Throwable 。这将导致在具有ChannelInboundHandler.exceptionCaught(ChannelHandlerContext, Throwable)方法称为下一个的ChannelInboundHandler包含在ChannelPipeline的的Channel 。
    
    Specified by:
    
    fireExceptionCaught在界面 ChannelInboundInvoker
  - fireUserEventTriggered
```
ChannelHandlerContext fireUserEventTriggered(java.lang.Object evt)
```
    从接口ChannelInboundInvoker复制的描述
    
    A Channel收到用户定义的事件。这将导致在具有ChannelInboundHandler.userEventTriggered(ChannelHandlerContext, Object)方法称为下一个的ChannelInboundHandler包含在ChannelPipeline的的Channel 。
    
    Specified by:
    
    fireUserEventTriggered在界面 ChannelInboundInvoker
  - fireChannelRead
```
ChannelHandlerContext fireChannelRead(java.lang.Object msg)
```
    从接口ChannelInboundInvoker复制的描述
    
    A Channel收到了一条消息。这将导致在具有ChannelInboundHandler.channelRead(ChannelHandlerContext, Object)方法称为下一个的ChannelInboundHandler包含在ChannelPipeline的的Channel 。
    
    Specified by:
    
    fireChannelRead在界面 ChannelInboundInvoker
  - fireChannelReadComplete
```
ChannelHandlerContext fireChannelReadComplete()
```
    从接口ChannelInboundInvoker复制的描述
    
    触发ChannelInboundHandler.channelReadComplete(ChannelHandlerContext)事件到下一个ChannelInboundHandler在ChannelPipeline 。
    
    Specified by:
    
    fireChannelReadComplete在界面 ChannelInboundInvoker
  - fireChannelWritabilityChanged
```
ChannelHandlerContext fireChannelWritabilityChanged()
```
    从接口ChannelInboundInvoker复制的描述
    
    触发ChannelInboundHandler.channelWritabilityChanged(ChannelHandlerContext)事件到ChannelPipeline中的下一个ChannelInboundHandler 。
    
    Specified by:
    
    fireChannelWritabilityChanged在界面 ChannelInboundInvoker
  - read
```
ChannelHandlerContext read()
```
    从接口ChannelOutboundInvoker复制的描述
    
    请求将数据从Channel读取到第一个入站缓冲区，如果读取数据，则触发ChannelInboundHandler.channelRead(ChannelHandlerContext, Object)事件，并触发channelReadComplete事件，以便处理程序可以决定继续读取数据。如果已经有待处理的读取操作，则此方法不执行任何操作。
    这将导致在具有ChannelOutboundHandler.read(ChannelHandlerContext)方法称为下一个的ChannelOutboundHandler包含在ChannelPipeline的的Channel 。
    
    Specified by:
    
    read接口 ChannelOutboundInvoker
  - flush
```
ChannelHandlerContext flush()
```
    从接口复制的描述： ChannelOutboundInvoker
    
    请求通过此ChannelOutboundInvoker清除所有未决消息。
    
    Specified by:
    
    flush在界面 ChannelOutboundInvoker
  - pipeline
```
ChannelPipeline pipeline()
```
    返回分配的ChannelPipeline
  - alloc
```
ByteBufAllocator alloc()
```
    返回分配的ByteBufAllocator这将被用于分配ByteBuf秒。
  - attr
```
@Deprecated
<T> Attribute<T> attr(AttributeKey<T> key)
```
    已过时。使用AttributeMap.attr(AttributeKey)
    
    从接口AttributeMap复制的描述
    
    获得AttributeKey的Attribute 。此方法永远不会返回null，但可能会返回尚未设置值的Attribute 。
    
    Specified by:
    
    attr在界面 AttributeMap
  - hasAttr
```
@Deprecated
<T> boolean hasAttr(AttributeKey<T> key)
```
    已过时。使用AttributeMap.hasAttr(AttributeKey)
    
    从接口复制的描述： AttributeMap
    
    返回true当且仅当给定Attribute存在于这个AttributeMap 。
    
    Specified by:
    
    hasAttr在界面 AttributeMap

Interface ChannelHandlerContext

通知

修改管道

检索以备后用

存储有状态的信息

处理程序可以有多个上下文

值得阅读的额外资源

方法摘要

Methods inherited from interface io.netty.channel.ChannelOutboundInvoker

方法详细信息

channel

executor

name

handler

isRemoved

fireChannelRegistered

fireChannelUnregistered

fireChannelActive

fireChannelInactive

fireExceptionCaught

fireUserEventTriggered

fireChannelRead

fireChannelReadComplete

fireChannelWritabilityChanged

read

flush

pipeline

alloc

attr

hasAttr