AbstractChannelHandlerContext

java.lang.Object
- io.netty.util.DefaultAttributeMap
- - io.netty.channel.AbstractChannelHandlerContext

All Implemented Interfaces:

ChannelHandlerContext, AttributeMap

Direct Known Subclasses:

DefaultChannelHandlerContext, DefaultChannelPipeline.HeadContext, DefaultChannelPipeline.TailContext
```
abstract class AbstractChannelHandlerContext
extends DefaultAttributeMap
implements ChannelHandlerContext
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`(package private) static class`	`AbstractChannelHandlerContext.AbstractWriteTask`
`(package private) static class`	`AbstractChannelHandlerContext.WriteAndFlushTask`
`(package private) static class`	`AbstractChannelHandlerContext.WriteTask`

Field Summary

Fields
Modifier and Type	Field and Description
`private static int`	`ADD_COMPLETE` `ChannelHandler.handlerAdded(ChannelHandlerContext)` was called.
`private static int`	`ADD_PENDING` `ChannelHandler.handlerAdded(ChannelHandlerContext)` is about to be called.
`(package private) EventExecutor`	`executor`
`private static java.util.concurrent.atomic.AtomicIntegerFieldUpdater<AbstractChannelHandlerContext>`	`HANDLER_STATE_UPDATER`
`private int`	`handlerState`
`private boolean`	`inbound`
`private static int`	`INIT` Neither `ChannelHandler.handlerAdded(ChannelHandlerContext)` nor `ChannelHandler.handlerRemoved(ChannelHandlerContext)` was called.
`private java.lang.Runnable`	`invokeChannelReadCompleteTask`
`private java.lang.Runnable`	`invokeChannelWritableStateChangedTask`
`private java.lang.Runnable`	`invokeFlushTask`
`private java.lang.Runnable`	`invokeReadTask`
`private java.lang.String`	`name`
`(package private) AbstractChannelHandlerContext`	`next`
`private boolean`	`ordered`
`private boolean`	`outbound`
`private DefaultChannelPipeline`	`pipeline`
`(package private) AbstractChannelHandlerContext`	`prev`
`private static int`	`REMOVE_COMPLETE` `ChannelHandler.handlerRemoved(ChannelHandlerContext)` was called.
`private ChannelFuture`	`succeededFuture`

Constructor Summary

Constructors
Constructor and Description
`AbstractChannelHandlerContext(DefaultChannelPipeline pipeline, EventExecutor executor, java.lang.String name, boolean inbound, boolean outbound)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ByteBufAllocator`	`alloc()` Return the assigned `ByteBufAllocator` which will be used to allocate `ByteBuf`s.
`ChannelFuture`	`bind(java.net.SocketAddress localAddress)` Request to bind to the given `SocketAddress` and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`ChannelFuture`	`bind(java.net.SocketAddress localAddress, ChannelPromise promise)` Request to bind to the given `SocketAddress` and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`Channel`	`channel()` Return the `Channel` which is bound to the `ChannelHandlerContext`.
`ChannelFuture`	`close()` Request to close the `Channel` and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`ChannelFuture`	`close(ChannelPromise promise)` Request to close the `Channel` and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`ChannelFuture`	`connect(java.net.SocketAddress remoteAddress)` Request to connect to the given `SocketAddress` and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`ChannelFuture`	`connect(java.net.SocketAddress remoteAddress, ChannelPromise promise)` Request to connect to the given `SocketAddress` and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`ChannelFuture`	`connect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress)` Request to connect to the given `SocketAddress` while bind to the localAddress and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`ChannelFuture`	`connect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress, ChannelPromise promise)` Request to connect to the given `SocketAddress` while bind to the localAddress and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`ChannelFuture`	`deregister()` Request to deregister from the previous assigned `EventExecutor` and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`ChannelFuture`	`deregister(ChannelPromise promise)` Request to deregister from the previous assigned `EventExecutor` and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`ChannelFuture`	`disconnect()` Request to disconnect from the remote peer and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`ChannelFuture`	`disconnect(ChannelPromise promise)` Request to disconnect from the remote peer and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`EventExecutor`	`executor()` The `EventExecutor` that is used to dispatch the events.
`private AbstractChannelHandlerContext`	`findContextInbound()`
`private AbstractChannelHandlerContext`	`findContextOutbound()`
`ChannelHandlerContext`	`fireChannelActive()` A `Channel` is active now, which means it is connected.
`ChannelHandlerContext`	`fireChannelInactive()` A `Channel` is inactive now, which means it is closed.
`ChannelHandlerContext`	`fireChannelRead(java.lang.Object msg)` A `Channel` received a message.
`ChannelHandlerContext`	`fireChannelReadComplete()` Triggers an `ChannelInboundHandler.channelReadComplete(ChannelHandlerContext)` event to the next `ChannelInboundHandler` in the `ChannelPipeline`.
`ChannelHandlerContext`	`fireChannelRegistered()` A `Channel` was registered to its `EventLoop`.
`ChannelHandlerContext`	`fireChannelUnregistered()` A `Channel` was unregistered from its `EventLoop`.
`ChannelHandlerContext`	`fireChannelWritabilityChanged()` Triggers an `ChannelInboundHandler.channelWritabilityChanged(ChannelHandlerContext)` event to the next `ChannelInboundHandler` in the `ChannelPipeline`.
`ChannelHandlerContext`	`fireExceptionCaught(java.lang.Throwable cause)` A `Channel` received an `Throwable` in one of its inbound operations.
`ChannelHandlerContext`	`fireUserEventTriggered(java.lang.Object event)` A `Channel` received an user defined event.
`ChannelHandlerContext`	`flush()` Request to flush all pending messages via this ChannelOutboundInvoker.
`private static boolean`	`inExceptionCaught(java.lang.Throwable cause)`
`private void`	`invokeBind(java.net.SocketAddress localAddress, ChannelPromise promise)`
`private void`	`invokeChannelActive()`
`(package private) static void`	`invokeChannelActive(AbstractChannelHandlerContext next)`
`private void`	`invokeChannelInactive()`
`(package private) static void`	`invokeChannelInactive(AbstractChannelHandlerContext next)`
`(package private) static void`	`invokeChannelRead(AbstractChannelHandlerContext next, java.lang.Object msg)`
`private void`	`invokeChannelRead(java.lang.Object msg)`
`private void`	`invokeChannelReadComplete()`
`(package private) static void`	`invokeChannelReadComplete(AbstractChannelHandlerContext next)`
`private void`	`invokeChannelRegistered()`
`(package private) static void`	`invokeChannelRegistered(AbstractChannelHandlerContext next)`
`private void`	`invokeChannelUnregistered()`
`(package private) static void`	`invokeChannelUnregistered(AbstractChannelHandlerContext next)`
`private void`	`invokeChannelWritabilityChanged()`
`(package private) static void`	`invokeChannelWritabilityChanged(AbstractChannelHandlerContext next)`
`private void`	`invokeClose(ChannelPromise promise)`
`private void`	`invokeConnect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress, ChannelPromise promise)`
`private void`	`invokeDeregister(ChannelPromise promise)`
`private void`	`invokeDisconnect(ChannelPromise promise)`
`(package private) static void`	`invokeExceptionCaught(AbstractChannelHandlerContext next, java.lang.Throwable cause)`
`private void`	`invokeExceptionCaught(java.lang.Throwable cause)`
`private void`	`invokeFlush()`
`private void`	`invokeFlush0()`
`private boolean`	`invokeHandler()` Makes best possible effort to detect if `ChannelHandler.handlerAdded(ChannelHandlerContext)` was called yet.
`private void`	`invokeRead()`
`(package private) static void`	`invokeUserEventTriggered(AbstractChannelHandlerContext next, java.lang.Object event)`
`private void`	`invokeUserEventTriggered(java.lang.Object event)`
`private void`	`invokeWrite(java.lang.Object msg, ChannelPromise promise)`
`private void`	`invokeWrite0(java.lang.Object msg, ChannelPromise promise)`
`private void`	`invokeWriteAndFlush(java.lang.Object msg, ChannelPromise promise)`
`boolean`	`isRemoved()` Return `true` if the `ChannelHandler` which belongs to this context was removed from the `ChannelPipeline`.
`java.lang.String`	`name()` The unique name of the `ChannelHandlerContext`.The name was used when then `ChannelHandler` was added to the `ChannelPipeline`.
`ChannelFuture`	`newFailedFuture(java.lang.Throwable cause)` Create a new `ChannelFuture` which is marked as failed already.
`ChannelProgressivePromise`	`newProgressivePromise()` Return an new `ChannelProgressivePromise`
`ChannelPromise`	`newPromise()` Return a new `ChannelPromise`.
`ChannelFuture`	`newSucceededFuture()` Create a new `ChannelFuture` which is marked as succeeded already.
`private void`	`notifyHandlerException(java.lang.Throwable cause)`
`private static void`	`notifyOutboundHandlerException(java.lang.Throwable cause, ChannelPromise promise)`
`ChannelPipeline`	`pipeline()` Return the assigned `ChannelPipeline`
`ChannelHandlerContext`	`read()` Request to Read data from the `Channel` into the first inbound buffer, triggers an `ChannelInboundHandler.channelRead(ChannelHandlerContext, Object)` event if data was read, and triggers a `channelReadComplete` event so the handler can decide to continue reading.
`private static void`	`safeExecute(EventExecutor executor, java.lang.Runnable runnable, ChannelPromise promise, java.lang.Object msg)`
`(package private) void`	`setAddComplete()`
`(package private) void`	`setAddPending()`
`(package private) void`	`setRemoved()`
`private boolean`	`validatePromise(ChannelPromise promise, boolean allowVoidPromise)`
`ChannelPromise`	`voidPromise()` Return a special ChannelPromise which can be reused for different operations.
`ChannelFuture`	`write(java.lang.Object msg)` Request to write a message via this `ChannelHandlerContext` through the `ChannelPipeline`.
`private void`	`write(java.lang.Object msg, boolean flush, ChannelPromise promise)`
`ChannelFuture`	`write(java.lang.Object msg, ChannelPromise promise)` Request to write a message via this `ChannelHandlerContext` through the `ChannelPipeline`.
`ChannelFuture`	`writeAndFlush(java.lang.Object msg)` Shortcut for call `ChannelHandlerContext.write(Object)` and `ChannelHandlerContext.flush()`.
`ChannelFuture`	`writeAndFlush(java.lang.Object msg, ChannelPromise promise)` Shortcut for call `ChannelHandlerContext.write(Object, ChannelPromise)` and `ChannelHandlerContext.flush()`.

Methods inherited from class io.netty.util.DefaultAttributeMap
attr

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.netty.channel.ChannelHandlerContext
handler

Methods inherited from interface io.netty.util.AttributeMap
attr

- Field Detail
  - next
```
volatile AbstractChannelHandlerContext next
```
  - prev
```
volatile AbstractChannelHandlerContext prev
```
  - HANDLER_STATE_UPDATER
```
private static final java.util.concurrent.atomic.AtomicIntegerFieldUpdater<AbstractChannelHandlerContext> HANDLER_STATE_UPDATER
```
  - ADD_PENDING
```
private static final int ADD_PENDING
```
    ChannelHandler.handlerAdded(ChannelHandlerContext) is about to be called.
    
    See Also:
    
    Constant Field Values
  - ADD_COMPLETE
```
private static final int ADD_COMPLETE
```
    ChannelHandler.handlerAdded(ChannelHandlerContext) was called.
    
    See Also:
    
    Constant Field Values
  - REMOVE_COMPLETE
```
private static final int REMOVE_COMPLETE
```
    ChannelHandler.handlerRemoved(ChannelHandlerContext) was called.
    
    See Also:
    
    Constant Field Values
  - INIT
```
private static final int INIT
```
    Neither ChannelHandler.handlerAdded(ChannelHandlerContext) nor ChannelHandler.handlerRemoved(ChannelHandlerContext) was called.
    
    See Also:
    
    Constant Field Values
  - inbound
```
private final boolean inbound
```
  - outbound
```
private final boolean outbound
```
  - pipeline
```
private final DefaultChannelPipeline pipeline
```
  - name
```
private final java.lang.String name
```
  - ordered
```
private final boolean ordered
```
  - executor
```
final EventExecutor executor
```
  - succeededFuture
```
private ChannelFuture succeededFuture
```
  - invokeChannelReadCompleteTask
```
private java.lang.Runnable invokeChannelReadCompleteTask
```
  - invokeReadTask
```
private java.lang.Runnable invokeReadTask
```
  - invokeChannelWritableStateChangedTask
```
private java.lang.Runnable invokeChannelWritableStateChangedTask
```
  - invokeFlushTask
```
private java.lang.Runnable invokeFlushTask
```
  - handlerState
```
private volatile int handlerState
```
- Constructor Detail
  - AbstractChannelHandlerContext
```
AbstractChannelHandlerContext(DefaultChannelPipeline pipeline,
                              EventExecutor executor,
                              java.lang.String name,
                              boolean inbound,
                              boolean outbound)
```
- Method Detail
  - channel
```
public Channel channel()
```
    Description copied from interface: ChannelHandlerContext
    
    Return the Channel which is bound to the ChannelHandlerContext.
    
    Specified by:
    
    channel in interface ChannelHandlerContext
  - pipeline
```
public ChannelPipeline pipeline()
```
    Description copied from interface: ChannelHandlerContext
    
    Return the assigned ChannelPipeline
    
    Specified by:
    
    pipeline in interface ChannelHandlerContext
  - alloc
```
public ByteBufAllocator alloc()
```
    Description copied from interface: ChannelHandlerContext
    
    Return the assigned ByteBufAllocator which will be used to allocate ByteBufs.
    
    Specified by:
    
    alloc in interface ChannelHandlerContext
  - executor
```
public EventExecutor executor()
```
    Description copied from interface: ChannelHandlerContext
    
    The EventExecutor that is used to dispatch the events. This can also be used to directly submit tasks that get executed in the event loop. For more information please refer to the EventExecutor javadoc.
    
    Specified by:
    
    executor in interface ChannelHandlerContext
  - name
```
public java.lang.String name()
```
    Description copied from interface: ChannelHandlerContext
    
    The unique name of the ChannelHandlerContext.The name was used when then ChannelHandler was added to the ChannelPipeline. This name can also be used to access the registered ChannelHandler from the ChannelPipeline.
    
    Specified by:
    
    name in interface ChannelHandlerContext
  - fireChannelRegistered
```
public ChannelHandlerContext fireChannelRegistered()
```
    Description copied from interface: ChannelHandlerContext
    
    A Channel was registered to its EventLoop. This will result in having the ChannelInboundHandler.channelRegistered(ChannelHandlerContext) method called of the next ChannelInboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    fireChannelRegistered in interface ChannelHandlerContext
  - invokeChannelRegistered
```
static void invokeChannelRegistered(AbstractChannelHandlerContext next)
```
  - invokeChannelRegistered
```
private void invokeChannelRegistered()
```
  - fireChannelUnregistered
```
public ChannelHandlerContext fireChannelUnregistered()
```
    Description copied from interface: ChannelHandlerContext
    
    A Channel was unregistered from its EventLoop. This will result in having the ChannelInboundHandler.channelUnregistered(ChannelHandlerContext) method called of the next ChannelInboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    fireChannelUnregistered in interface ChannelHandlerContext
  - invokeChannelUnregistered
```
static void invokeChannelUnregistered(AbstractChannelHandlerContext next)
```
  - invokeChannelUnregistered
```
private void invokeChannelUnregistered()
```
  - fireChannelActive
```
public ChannelHandlerContext fireChannelActive()
```
    Description copied from interface: ChannelHandlerContext
    
    A Channel is active now, which means it is connected. This will result in having the ChannelInboundHandler.channelActive(ChannelHandlerContext) method called of the next ChannelInboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    fireChannelActive in interface ChannelHandlerContext
  - invokeChannelActive
```
static void invokeChannelActive(AbstractChannelHandlerContext next)
```
  - invokeChannelActive
```
private void invokeChannelActive()
```
  - fireChannelInactive
```
public ChannelHandlerContext fireChannelInactive()
```
    Description copied from interface: ChannelHandlerContext
    
    A Channel is inactive now, which means it is closed. This will result in having the ChannelInboundHandler.channelInactive(ChannelHandlerContext) method called of the next ChannelInboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    fireChannelInactive in interface ChannelHandlerContext
  - invokeChannelInactive
```
static void invokeChannelInactive(AbstractChannelHandlerContext next)
```
  - invokeChannelInactive
```
private void invokeChannelInactive()
```
  - fireExceptionCaught
```
public ChannelHandlerContext fireExceptionCaught(java.lang.Throwable cause)
```
    Description copied from interface: ChannelHandlerContext
    
    A Channel received an Throwable in one of its inbound operations. This will result in having the ChannelInboundHandler.exceptionCaught(ChannelHandlerContext, Throwable) method called of the next ChannelInboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    fireExceptionCaught in interface ChannelHandlerContext
  - invokeExceptionCaught
```
static void invokeExceptionCaught(AbstractChannelHandlerContext next,
                                  java.lang.Throwable cause)
```
  - invokeExceptionCaught
```
private void invokeExceptionCaught(java.lang.Throwable cause)
```
  - fireUserEventTriggered
```
public ChannelHandlerContext fireUserEventTriggered(java.lang.Object event)
```
    Description copied from interface: ChannelHandlerContext
    
    A Channel received an user defined event. This will result in having the ChannelInboundHandler.userEventTriggered(ChannelHandlerContext, Object) method called of the next ChannelInboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    fireUserEventTriggered in interface ChannelHandlerContext
  - invokeUserEventTriggered
```
static void invokeUserEventTriggered(AbstractChannelHandlerContext next,
                                     java.lang.Object event)
```
  - invokeUserEventTriggered
```
private void invokeUserEventTriggered(java.lang.Object event)
```
  - fireChannelRead
```
public ChannelHandlerContext fireChannelRead(java.lang.Object msg)
```
    Description copied from interface: ChannelHandlerContext
    
    A Channel received a message. This will result in having the ChannelInboundHandler.channelRead(ChannelHandlerContext, Object) method called of the next ChannelInboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    fireChannelRead in interface ChannelHandlerContext
  - invokeChannelRead
```
static void invokeChannelRead(AbstractChannelHandlerContext next,
                              java.lang.Object msg)
```
  - invokeChannelRead
```
private void invokeChannelRead(java.lang.Object msg)
```
  - fireChannelReadComplete
```
public ChannelHandlerContext fireChannelReadComplete()
```
    Description copied from interface: ChannelHandlerContext
    
    Triggers an ChannelInboundHandler.channelReadComplete(ChannelHandlerContext) event to the next ChannelInboundHandler in the ChannelPipeline.
    
    Specified by:
    
    fireChannelReadComplete in interface ChannelHandlerContext
  - invokeChannelReadComplete
```
static void invokeChannelReadComplete(AbstractChannelHandlerContext next)
```
  - invokeChannelReadComplete
```
private void invokeChannelReadComplete()
```
  - fireChannelWritabilityChanged
```
public ChannelHandlerContext fireChannelWritabilityChanged()
```
    Description copied from interface: ChannelHandlerContext
    
    Triggers an ChannelInboundHandler.channelWritabilityChanged(ChannelHandlerContext) event to the next ChannelInboundHandler in the ChannelPipeline.
    
    Specified by:
    
    fireChannelWritabilityChanged in interface ChannelHandlerContext
  - invokeChannelWritabilityChanged
```
static void invokeChannelWritabilityChanged(AbstractChannelHandlerContext next)
```
  - invokeChannelWritabilityChanged
```
private void invokeChannelWritabilityChanged()
```
  - bind
```
public ChannelFuture bind(java.net.SocketAddress localAddress)
```
    Description copied from interface: ChannelHandlerContext
    
    Request to bind to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
    This will result in having the ChannelOutboundHandler.bind(ChannelHandlerContext, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    bind in interface ChannelHandlerContext
  - connect
```
public ChannelFuture connect(java.net.SocketAddress remoteAddress)
```
    Description copied from interface: ChannelHandlerContext
    
    Request to connect to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
    If the connection fails because of a connection timeout, the ChannelFuture will get failed with a ConnectTimeoutException. If it fails because of connection refused a ConnectException will be used.
    This will result in having the ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    connect in interface ChannelHandlerContext
  - connect
```
public ChannelFuture connect(java.net.SocketAddress remoteAddress,
                             java.net.SocketAddress localAddress)
```
    Description copied from interface: ChannelHandlerContext
    
    Request to connect to the given SocketAddress while bind to the localAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
    This will result in having the ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    connect in interface ChannelHandlerContext
  - disconnect
```
public ChannelFuture disconnect()
```
    Description copied from interface: ChannelHandlerContext
    
    Request to disconnect from the remote peer and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
    This will result in having the ChannelOutboundHandler.disconnect(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    disconnect in interface ChannelHandlerContext
  - close
```
public ChannelFuture close()
```
    Description copied from interface: ChannelHandlerContext
    
    Request to close the Channel and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. After it is closed it is not possible to reuse it again.
    This will result in having the ChannelOutboundHandler.close(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    close in interface ChannelHandlerContext
  - deregister
```
public ChannelFuture deregister()
```
    Description copied from interface: ChannelHandlerContext
    
    Request to deregister from the previous assigned EventExecutor and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
    This will result in having the ChannelOutboundHandler.deregister(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    deregister in interface ChannelHandlerContext
  - bind
```
public ChannelFuture bind(java.net.SocketAddress localAddress,
                          ChannelPromise promise)
```
    Description copied from interface: ChannelHandlerContext
    
    Request to bind to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. The given ChannelPromise will be notified.
    This will result in having the ChannelOutboundHandler.bind(ChannelHandlerContext, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    bind in interface ChannelHandlerContext
  - invokeBind
```
private void invokeBind(java.net.SocketAddress localAddress,
                        ChannelPromise promise)
```
  - connect
```
public ChannelFuture connect(java.net.SocketAddress remoteAddress,
                             ChannelPromise promise)
```
    Description copied from interface: ChannelHandlerContext
    
    Request to connect to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. The given ChannelFuture will be notified.
    If the connection fails because of a connection timeout, the ChannelFuture will get failed with a ConnectTimeoutException. If it fails because of connection refused a ConnectException will be used.
    This will result in having the ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    connect in interface ChannelHandlerContext
  - connect
```
public ChannelFuture connect(java.net.SocketAddress remoteAddress,
                             java.net.SocketAddress localAddress,
                             ChannelPromise promise)
```
    Description copied from interface: ChannelHandlerContext
    
    Request to connect to the given SocketAddress while bind to the localAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. The given ChannelPromise will be notified and also returned.
    This will result in having the ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    connect in interface ChannelHandlerContext
  - invokeConnect
```
private void invokeConnect(java.net.SocketAddress remoteAddress,
                           java.net.SocketAddress localAddress,
                           ChannelPromise promise)
```
  - disconnect
```
public ChannelFuture disconnect(ChannelPromise promise)
```
    Description copied from interface: ChannelHandlerContext
    
    Request to disconnect from the remote peer and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. The given ChannelPromise will be notified.
    This will result in having the ChannelOutboundHandler.disconnect(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    disconnect in interface ChannelHandlerContext
  - invokeDisconnect
```
private void invokeDisconnect(ChannelPromise promise)
```
  - close
```
public ChannelFuture close(ChannelPromise promise)
```
    Description copied from interface: ChannelHandlerContext
    
    Request to close the Channel and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. After it is closed it is not possible to reuse it again. The given ChannelPromise will be notified.
    This will result in having the ChannelOutboundHandler.close(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    close in interface ChannelHandlerContext
  - invokeClose
```
private void invokeClose(ChannelPromise promise)
```
  - deregister
```
public ChannelFuture deregister(ChannelPromise promise)
```
    Description copied from interface: ChannelHandlerContext
    
    Request to deregister from the previous assigned EventExecutor and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. The given ChannelPromise will be notified.
    This will result in having the ChannelOutboundHandler.deregister(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    deregister in interface ChannelHandlerContext
  - invokeDeregister
```
private void invokeDeregister(ChannelPromise promise)
```
  - read
```
public ChannelHandlerContext read()
```
    Description copied from interface: ChannelHandlerContext
    
    Request to Read data from the Channel into the first inbound buffer, triggers an ChannelInboundHandler.channelRead(ChannelHandlerContext, Object) event if data was read, and triggers a channelReadComplete event so the handler can decide to continue reading. If there's a pending read operation already, this method does nothing.
    This will result in having the ChannelOutboundHandler.read(ChannelHandlerContext) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    read in interface ChannelHandlerContext
  - invokeRead
```
private void invokeRead()
```
  - write
```
public ChannelFuture write(java.lang.Object msg)
```
    Description copied from interface: ChannelHandlerContext
    
    Request to write a message via this ChannelHandlerContext through the ChannelPipeline. This method will not request to actual flush, so be sure to call ChannelHandlerContext.flush() once you want to request to flush all pending data to the actual transport.
    
    Specified by:
    
    write in interface ChannelHandlerContext
  - write
```
public ChannelFuture write(java.lang.Object msg,
                           ChannelPromise promise)
```
    Description copied from interface: ChannelHandlerContext
    
    Request to write a message via this ChannelHandlerContext through the ChannelPipeline. This method will not request to actual flush, so be sure to call ChannelHandlerContext.flush() once you want to request to flush all pending data to the actual transport.
    
    Specified by:
    
    write in interface ChannelHandlerContext
  - invokeWrite
```
private void invokeWrite(java.lang.Object msg,
                         ChannelPromise promise)
```
  - invokeWrite0
```
private void invokeWrite0(java.lang.Object msg,
                          ChannelPromise promise)
```
  - flush
```
public ChannelHandlerContext flush()
```
    Description copied from interface: ChannelHandlerContext
    
    Request to flush all pending messages via this ChannelOutboundInvoker.
    
    Specified by:
    
    flush in interface ChannelHandlerContext
  - invokeFlush
```
private void invokeFlush()
```
  - invokeFlush0
```
private void invokeFlush0()
```
  - writeAndFlush
```
public ChannelFuture writeAndFlush(java.lang.Object msg,
                                   ChannelPromise promise)
```
    Description copied from interface: ChannelHandlerContext
    
    Shortcut for call ChannelHandlerContext.write(Object, ChannelPromise) and ChannelHandlerContext.flush().
    
    Specified by:
    
    writeAndFlush in interface ChannelHandlerContext
  - invokeWriteAndFlush
```
private void invokeWriteAndFlush(java.lang.Object msg,
                                 ChannelPromise promise)
```
  - write
```
private void write(java.lang.Object msg,
                   boolean flush,
                   ChannelPromise promise)
```
  - writeAndFlush
```
public ChannelFuture writeAndFlush(java.lang.Object msg)
```
    Description copied from interface: ChannelHandlerContext
    
    Shortcut for call ChannelHandlerContext.write(Object) and ChannelHandlerContext.flush().
    
    Specified by:
    
    writeAndFlush in interface ChannelHandlerContext
  - notifyOutboundHandlerException
```
private static void notifyOutboundHandlerException(java.lang.Throwable cause,
                                                   ChannelPromise promise)
```
  - notifyHandlerException
```
private void notifyHandlerException(java.lang.Throwable cause)
```
  - inExceptionCaught
```
private static boolean inExceptionCaught(java.lang.Throwable cause)
```
  - newPromise
```
public ChannelPromise newPromise()
```
    Description copied from interface: ChannelHandlerContext
    
    Return a new ChannelPromise.
    
    Specified by:
    
    newPromise in interface ChannelHandlerContext
  - newProgressivePromise
```
public ChannelProgressivePromise newProgressivePromise()
```
    Description copied from interface: ChannelHandlerContext
    
    Return an new ChannelProgressivePromise
    
    Specified by:
    
    newProgressivePromise in interface ChannelHandlerContext
  - newSucceededFuture
```
public ChannelFuture newSucceededFuture()
```
    Description copied from interface: ChannelHandlerContext
    
    Create a new ChannelFuture which is marked as succeeded already. So Future.isSuccess() will return true. All FutureListener added to it will be notified directly. Also every call of blocking methods will just return without blocking.
    
    Specified by:
    
    newSucceededFuture in interface ChannelHandlerContext
  - newFailedFuture
```
public ChannelFuture newFailedFuture(java.lang.Throwable cause)
```
    Description copied from interface: ChannelHandlerContext
    
    Create a new ChannelFuture which is marked as failed already. So Future.isSuccess() will return false. All FutureListener added to it will be notified directly. Also every call of blocking methods will just return without blocking.
    
    Specified by:
    
    newFailedFuture in interface ChannelHandlerContext
  - validatePromise
```
private boolean validatePromise(ChannelPromise promise,
                                boolean allowVoidPromise)
```
  - findContextInbound
```
private AbstractChannelHandlerContext findContextInbound()
```
  - findContextOutbound
```
private AbstractChannelHandlerContext findContextOutbound()
```
  - voidPromise
```
public ChannelPromise voidPromise()
```
    Description copied from interface: ChannelHandlerContext
    
    Return a special ChannelPromise which can be reused for different operations.
    It's only supported to use it for ChannelHandlerContext.write(Object, ChannelPromise).
    
    Be aware that the returned ChannelPromise will not support most operations and should only be used if you want to save an object allocation for every write operation. You will not be able to detect if the operation was complete, only if it failed as the implementation will call ChannelPipeline.fireExceptionCaught(Throwable) in this case.
    Be aware this is an expert feature and should be used with care!
    
    Specified by:
    
    voidPromise in interface ChannelHandlerContext
  - setRemoved
```
final void setRemoved()
```
  - setAddComplete
```
final void setAddComplete()
```
  - setAddPending
```
final void setAddPending()
```
  - invokeHandler
```
private boolean invokeHandler()
```
    Makes best possible effort to detect if ChannelHandler.handlerAdded(ChannelHandlerContext) was called yet. If not return false and if called or could not detect return true. If this method returns true we will not invoke the ChannelHandler but just forward the event. This is needed as DefaultChannelPipeline may already put the ChannelHandler in the linked-list but not called ChannelHandler.handlerAdded(ChannelHandlerContext).
  - isRemoved
```
public boolean isRemoved()
```
    Description copied from interface: ChannelHandlerContext
    
    Return true if the ChannelHandler which belongs to this context was removed from the ChannelPipeline. Note that this method is only meant to be called from with in the EventLoop.
    
    Specified by:
    
    isRemoved in interface ChannelHandlerContext
  - safeExecute
```
private static void safeExecute(EventExecutor executor,
                                java.lang.Runnable runnable,
                                ChannelPromise promise,
                                java.lang.Object msg)
```

Class AbstractChannelHandlerContext

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class io.netty.util.DefaultAttributeMap

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.channel.ChannelHandlerContext

Methods inherited from interface io.netty.util.AttributeMap

Field Detail

next

prev

HANDLER_STATE_UPDATER

ADD_PENDING

ADD_COMPLETE

REMOVE_COMPLETE

INIT

inbound

outbound

pipeline

name

ordered

executor

succeededFuture

invokeChannelReadCompleteTask

invokeReadTask

invokeChannelWritableStateChangedTask

invokeFlushTask

handlerState

Constructor Detail

AbstractChannelHandlerContext

Method Detail

channel

pipeline

alloc

executor

name

fireChannelRegistered

invokeChannelRegistered

invokeChannelRegistered

fireChannelUnregistered

invokeChannelUnregistered

invokeChannelUnregistered

fireChannelActive

invokeChannelActive

invokeChannelActive

fireChannelInactive

invokeChannelInactive

invokeChannelInactive

fireExceptionCaught

invokeExceptionCaught

invokeExceptionCaught

fireUserEventTriggered

invokeUserEventTriggered

invokeUserEventTriggered

fireChannelRead

invokeChannelRead

invokeChannelRead

fireChannelReadComplete

invokeChannelReadComplete

invokeChannelReadComplete

fireChannelWritabilityChanged

invokeChannelWritabilityChanged

invokeChannelWritabilityChanged

bind

connect

connect

disconnect

close

deregister

bind

invokeBind

connect

connect

invokeConnect

disconnect

invokeDisconnect

close

invokeClose

deregister