DelegatingChannelHandlerContext (Netty API Reference (5.0.0.Alpha4))

Class DelegatingChannelHandlerContext

java.lang.Object
- io.netty5.channel.internal.DelegatingChannelHandlerContext

All Implemented Interfaces:

ChannelHandlerContext , ChannelInboundInvoker , ChannelOutboundInvoker , FuturePromiseFactory
```
public abstract class DelegatingChannelHandlerContext
extends Object
implements ChannelHandlerContext 
```

Constructor Summary

Constructors
Modifier Constructor Description

protected DelegatingChannelHandlerContext (ChannelHandlerContext ctx)

Constructors
Modifier	Constructor	Description
`protected`	`DelegatingChannelHandlerContext (ChannelHandlerContext ctx)`

Method Summary

All Methods
Modifier and Type	Method	Description
`Future<Void>`	`bind (SocketAddress localAddress)`	Request to bind to the given `SocketAddress` and notify the `Future` once the operation completes, either because the operation was successful or because of an error.
`BufferAllocator`	`bufferAllocator ()`	Return the assigned `BufferAllocator` which will be used to allocate `Buffer`s.
`Channel`	`channel ()`	Return the `Channel` which is bound to the `ChannelHandlerContext`.
`Future<Void>`	`close ()`	Request to close the `Channel` and notify the `Future` once the operation completes, either because the operation was successful or because of an error.
`Future<Void>`	`connect (SocketAddress remoteAddress)`	Request to connect to the given `SocketAddress` and notify the `Future` once the operation completes, either because the operation was successful or because of an error.
`Future<Void>`	`connect (SocketAddress remoteAddress, SocketAddress localAddress)`	Request to connect to the given `SocketAddress` while bind to the localAddress and notify the `Future` once the operation completes, either because the operation was successful or because of an error.
`ChannelHandlerContext`	`delegatingCtx ()`
`Future<Void>`	`deregister ()`	Request to deregister from the previous assigned `EventExecutor` and notify the `Future` once the operation completes, either because the operation was successful or because of an error.
`Future<Void>`	`disconnect ()`	Request to disconnect from the remote peer and notify the `Future` once the operation completes, either because the operation was successful or because of an error.
`EventExecutor`	`executor ()`	Returns the `EventExecutor` that is used to execute the operations of this `ChannelOutboundInvoker`.
`ChannelHandlerContext`	`fireChannelActive ()`	A `Channel` is active now, which means it is connected.
`ChannelHandlerContext`	`fireChannelExceptionCaught (Throwable cause)`	A `Channel` received an `Throwable` in one of its inbound operations.
`ChannelHandlerContext`	`fireChannelInactive ()`	A `Channel` is inactive now, which means it is closed.
`ChannelHandlerContext`	`fireChannelInboundEvent (Object evt)`	A `Channel` received a custom defined inbound event.
`ChannelHandlerContext`	`fireChannelRead (Object msg)`	A `Channel` received a message.
`ChannelHandlerContext`	`fireChannelReadComplete ()`	Triggers an `ChannelHandler.channelReadComplete(ChannelHandlerContext)` event to the next `ChannelHandler` in the `ChannelPipeline`.
`ChannelHandlerContext`	`fireChannelRegistered ()`	A `Channel` was registered to its `EventLoop`.
`ChannelHandlerContext`	`fireChannelShutdown (ChannelShutdownDirection direction)`	A `Channel` was shutdown in a specific direction.
`ChannelHandlerContext`	`fireChannelUnregistered ()`	A `Channel` was unregistered from its `EventLoop`.
`ChannelHandlerContext`	`fireChannelWritabilityChanged ()`	Triggers an `ChannelHandler.channelWritabilityChanged(ChannelHandlerContext)` event to the next `ChannelHandler` in the `ChannelPipeline`.
`ChannelHandlerContext`	`flush ()`	Request to flush all pending messages via this ChannelOutboundInvoker.
`ChannelHandler`	`handler ()`	The `ChannelHandler` that is bound this `ChannelHandlerContext`.
`boolean`	`isRemoved ()`	Return `true` if the `ChannelHandler` which belongs to this context was removed from the `ChannelPipeline`.
`String`	`name ()`	The unique name of the `ChannelHandlerContext`.The name was used when then `ChannelHandler` was added to the `ChannelPipeline`.
`<V> Future<V>`	`newFailedFuture (Throwable cause)`	Create a new `Future` which is marked as failed already.
`<V> Promise<V>`	`newPromise ()`	Return a new `Promise`.
`Future<Void>`	`newSucceededFuture ()`	Create a new `Future` which is marked as succeeded already.
`<V> Future<V>`	`newSucceededFuture (V value)`	Create a new `Future` which is marked as succeeded already.
`ChannelPipeline`	`pipeline ()`	Return the assigned `ChannelPipeline`
`ChannelHandlerContext`	`read ()`	Request to Read data from the `Channel` into the first inbound buffer, triggers an `ChannelHandler.channelRead(ChannelHandlerContext, Object)` event if data was read, and triggers a `channelReadComplete` event so the handler can decide to continue reading.
`Future<Void>`	`register ()`	Request to register on the `EventExecutor` for I/O processing.
`Future<Void>`	`sendOutboundEvent (Object event)`	Send a custom outbound event via this `ChannelOutboundInvoker` through the `ChannelPipeline`.
`Future<Void>`	`shutdown (ChannelShutdownDirection direction)`	Request shutdown one direction of the `Channel` and notify the `Future` once the operation completes, either because the operation was successful or because of an error.
`Future<Void>`	`write (Object msg)`	Request to write a message via this `ChannelHandlerContext` through the `ChannelPipeline`.
`Future<Void>`	`writeAndFlush (Object msg)`	Shortcut for call `ChannelOutboundInvoker.write(Object)` and `ChannelOutboundInvoker.flush()`.

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

- Constructor Detail
  - DelegatingChannelHandlerContext
```
protected DelegatingChannelHandlerContext(ChannelHandlerContext ctx)
```
- Method Detail
  - delegatingCtx
```
public final ChannelHandlerContext delegatingCtx()
```
  - channel
```
public Channel channel()
```
    Description copied from interface: ChannelHandlerContext
    
    Return the Channel which is bound to the ChannelHandlerContext.
    
    Specified by:
    
    channel in interface ChannelHandlerContext
  - executor
```
public EventExecutor executor()
```
    Description copied from interface: ChannelOutboundInvoker
    
    Returns the EventExecutor that is used to execute the operations of this ChannelOutboundInvoker.
    
    Specified by:
    
    executor in interface ChannelOutboundInvoker
    
    Returns:
    
    the executor.
  - name
```
public 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
  - handler
```
public ChannelHandler handler()
```
    Description copied from interface: ChannelHandlerContext
    
    The ChannelHandler that is bound this ChannelHandlerContext.
    
    Specified by:
    
    handler in interface 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.
    
    Specified by:
    
    isRemoved in interface ChannelHandlerContext
  - fireChannelRegistered
```
public ChannelHandlerContext fireChannelRegistered()
```
    Description copied from interface: ChannelInboundInvoker
    
    A Channel was registered to its EventLoop. This will result in having the ChannelHandler.channelRegistered(ChannelHandlerContext) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    fireChannelRegistered in interface ChannelHandlerContext
    
    Specified by:
    
    fireChannelRegistered in interface ChannelInboundInvoker
  - fireChannelUnregistered
```
public ChannelHandlerContext fireChannelUnregistered()
```
    Description copied from interface: ChannelInboundInvoker
    
    A Channel was unregistered from its EventLoop. This will result in having the ChannelHandler.channelUnregistered(ChannelHandlerContext) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    fireChannelUnregistered in interface ChannelHandlerContext
    
    Specified by:
    
    fireChannelUnregistered in interface ChannelInboundInvoker
  - fireChannelActive
```
public ChannelHandlerContext fireChannelActive()
```
    Description copied from interface: ChannelInboundInvoker
    
    A Channel is active now, which means it is connected. This will result in having the ChannelHandler.channelActive(ChannelHandlerContext) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    fireChannelActive in interface ChannelHandlerContext
    
    Specified by:
    
    fireChannelActive in interface ChannelInboundInvoker
  - fireChannelInactive
```
public ChannelHandlerContext fireChannelInactive()
```
    Description copied from interface: ChannelInboundInvoker
    
    A Channel is inactive now, which means it is closed. This will result in having the ChannelHandler.channelInactive(ChannelHandlerContext) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    fireChannelInactive in interface ChannelHandlerContext
    
    Specified by:
    
    fireChannelInactive in interface ChannelInboundInvoker
  - fireChannelShutdown
```
public ChannelHandlerContext fireChannelShutdown(ChannelShutdownDirection direction)
```
    Description copied from interface: ChannelInboundInvoker
    
    A Channel was shutdown in a specific direction. This will result in having the ChannelHandler.channelShutdown(ChannelHandlerContext, ChannelShutdownDirection) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    fireChannelShutdown in interface ChannelHandlerContext
    
    Specified by:
    
    fireChannelShutdown in interface ChannelInboundInvoker
  - fireChannelExceptionCaught
```
public ChannelHandlerContext fireChannelExceptionCaught(Throwable cause)
```
    Description copied from interface: ChannelInboundInvoker
    
    A Channel received an Throwable in one of its inbound operations. This will result in having the ChannelHandler.channelExceptionCaught(ChannelHandlerContext, Throwable) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    fireChannelExceptionCaught in interface ChannelHandlerContext
    
    Specified by:
    
    fireChannelExceptionCaught in interface ChannelInboundInvoker
  - fireChannelInboundEvent
```
public ChannelHandlerContext fireChannelInboundEvent(Object evt)
```
    Description copied from interface: ChannelInboundInvoker
    
    A Channel received a custom defined inbound event. This will result in having the ChannelHandler.channelInboundEvent(ChannelHandlerContext, Object) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    fireChannelInboundEvent in interface ChannelHandlerContext
    
    Specified by:
    
    fireChannelInboundEvent in interface ChannelInboundInvoker
  - fireChannelRead
```
public ChannelHandlerContext fireChannelRead(Object msg)
```
    Description copied from interface: ChannelInboundInvoker
    
    A Channel received a message. This will result in having the ChannelHandler.channelRead(ChannelHandlerContext, Object) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    fireChannelRead in interface ChannelHandlerContext
    
    Specified by:
    
    fireChannelRead in interface ChannelInboundInvoker
  - fireChannelReadComplete
```
public ChannelHandlerContext fireChannelReadComplete()
```
    Description copied from interface: ChannelInboundInvoker
    
    Triggers an ChannelHandler.channelReadComplete(ChannelHandlerContext) event to the next ChannelHandler in the ChannelPipeline.
    
    Specified by:
    
    fireChannelReadComplete in interface ChannelHandlerContext
    
    Specified by:
    
    fireChannelReadComplete in interface ChannelInboundInvoker
  - fireChannelWritabilityChanged
```
public ChannelHandlerContext fireChannelWritabilityChanged()
```
    Description copied from interface: ChannelInboundInvoker
    
    Triggers an ChannelHandler.channelWritabilityChanged(ChannelHandlerContext) event to the next ChannelHandler in the ChannelPipeline.
    
    Specified by:
    
    fireChannelWritabilityChanged in interface ChannelHandlerContext
    
    Specified by:
    
    fireChannelWritabilityChanged in interface ChannelInboundInvoker
  - read
```
public ChannelHandlerContext read()
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to Read data from the Channel into the first inbound buffer, triggers an ChannelHandler.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 ChannelHandler.read(ChannelHandlerContext) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    read in interface ChannelHandlerContext
    
    Specified by:
    
    read in interface ChannelOutboundInvoker
  - flush
```
public ChannelHandlerContext flush()
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to flush all pending messages via this ChannelOutboundInvoker.
    
    Specified by:
    
    flush in interface ChannelHandlerContext
    
    Specified by:
    
    flush in interface ChannelOutboundInvoker
  - sendOutboundEvent
```
public Future<Void> sendOutboundEvent(Object event)
```
    Description copied from interface: ChannelOutboundInvoker
    
    Send a custom outbound event via this ChannelOutboundInvoker through the ChannelPipeline.
    This will result in having the ChannelHandler.sendOutboundEvent(ChannelHandlerContext, Object) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    sendOutboundEvent in interface ChannelOutboundInvoker
  - pipeline
```
public ChannelPipeline pipeline()
```
    Description copied from interface: ChannelHandlerContext
    
    Return the assigned ChannelPipeline
    
    Specified by:
    
    pipeline in interface ChannelHandlerContext
  - bufferAllocator
```
public BufferAllocator bufferAllocator()
```
    Description copied from interface: ChannelHandlerContext
    
    Return the assigned BufferAllocator which will be used to allocate Buffers.
    
    Specified by:
    
    bufferAllocator in interface ChannelHandlerContext
  - bind
```
public Future<Void> bind(SocketAddress localAddress)
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to bind to the given SocketAddress and notify the Future once the operation completes, either because the operation was successful or because of an error.
    This will result in having the ChannelHandler.bind(ChannelHandlerContext, SocketAddress) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    bind in interface ChannelOutboundInvoker
  - connect
```
public Future<Void> connect(SocketAddress remoteAddress)
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to connect to the given SocketAddress and notify the Future 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 Future will get failed with a ConnectTimeoutException. If it fails because of connection refused a ConnectException will be used.
    This will result in having the ChannelHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    connect in interface ChannelOutboundInvoker
  - connect
```
public Future<Void> connect(SocketAddress remoteAddress,
 SocketAddress localAddress)
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to connect to the given SocketAddress while bind to the localAddress and notify the Future once the operation completes, either because the operation was successful or because of an error.
    This will result in having the ChannelHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    connect in interface ChannelOutboundInvoker
  - disconnect
```
public Future<Void> disconnect()
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to disconnect from the remote peer and notify the Future once the operation completes, either because the operation was successful or because of an error.
    This will result in having the ChannelHandler.disconnect(ChannelHandlerContext) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    disconnect in interface ChannelOutboundInvoker
  - close
```
public Future<Void> close()
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to close the Channel and notify the Future 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 ChannelHandler.close(ChannelHandlerContext) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    close in interface ChannelOutboundInvoker
  - shutdown
```
public Future<Void> shutdown(ChannelShutdownDirection direction)
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request shutdown one direction of the Channel and notify the Future once the operation completes, either because the operation was successful or because of an error.
    When completed, the channel will either not produce any inbound data anymore, or it will not be possible to write data anymore, depending on the given ChannelShutdownDirection.
    Depending on the transport implementation shutting down the ChannelShutdownDirection.Outbound or ChannelShutdownDirection.Inbound might also result in data transferred over the network. Like for example in case of TCP shutting down the ChannelShutdownDirection.Outbound will result in a FIN that is transmitted to the remote peer that will as a result shutdown ChannelShutdownDirection.Inbound.
    This will result in having the ChannelHandler.shutdown(ChannelHandlerContext, ChannelShutdownDirection). method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    shutdown in interface ChannelOutboundInvoker
  - deregister
```
public Future<Void> deregister()
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to deregister from the previous assigned EventExecutor and notify the Future once the operation completes, either because the operation was successful or because of an error.
    This will result in having the ChannelHandler.deregister(ChannelHandlerContext) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    deregister in interface ChannelOutboundInvoker
  - register
```
public Future<Void> register()
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to register on the EventExecutor for I/O processing. Future once the operation completes, either because the operation was successful or because of an error.
    This will result in having the ChannelHandler.register(ChannelHandlerContext) method called of the next ChannelHandler contained in the ChannelPipeline of the Channel.
    
    Specified by:
    
    register in interface ChannelOutboundInvoker
  - write
```
public Future<Void> write(Object msg)
```
    Description copied from interface: ChannelOutboundInvoker
    
    Request to write a message via this ChannelHandlerContext through the ChannelPipeline. This method will not request to actual flush, so be sure to call ChannelOutboundInvoker.flush() once you want to request to flush all pending data to the actual transport.
    
    Specified by:
    
    write in interface ChannelOutboundInvoker
  - writeAndFlush
```
public Future<Void> writeAndFlush(Object msg)
```
    Description copied from interface: ChannelOutboundInvoker
    
    Shortcut for call ChannelOutboundInvoker.write(Object) and ChannelOutboundInvoker.flush().
    
    Specified by:
    
    writeAndFlush in interface ChannelOutboundInvoker
  - newPromise
```
public <V> Promise<V> newPromise()
```
    Description copied from interface: FuturePromiseFactory
    
    Return a new Promise.
    
    Specified by:
    
    newPromise in interface ChannelOutboundInvoker
    
    Specified by:
    
    newPromise in interface FuturePromiseFactory
  - newSucceededFuture
```
public Future<Void> newSucceededFuture()
```
    Description copied from interface: FuturePromiseFactory
    
    Create a new Future which is marked as succeeded already. So AsynchronousResult.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 ChannelOutboundInvoker
    
    Specified by:
    
    newSucceededFuture in interface FuturePromiseFactory
  - newFailedFuture
```
public <V> Future<V> newFailedFuture(Throwable cause)
```
    Description copied from interface: FuturePromiseFactory
    
    Create a new Future which is marked as failed already. So AsynchronousResult.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 ChannelOutboundInvoker
    
    Specified by:
    
    newFailedFuture in interface FuturePromiseFactory
  - newSucceededFuture
```
public <V> Future<V> newSucceededFuture(V value)
```
    Description copied from interface: FuturePromiseFactory
    
    Create a new Future which is marked as succeeded already. So AsynchronousResult.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 ChannelOutboundInvoker
    
    Specified by:
    
    newSucceededFuture in interface FuturePromiseFactory

Class DelegatingChannelHandlerContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DelegatingChannelHandlerContext

Method Detail

delegatingCtx

channel

executor

name

handler

isRemoved

fireChannelRegistered

fireChannelUnregistered

fireChannelActive

fireChannelInactive

fireChannelShutdown

fireChannelExceptionCaught

fireChannelInboundEvent

fireChannelRead

fireChannelReadComplete

fireChannelWritabilityChanged

read

flush

sendOutboundEvent

pipeline

bufferAllocator

bind

connect

connect

disconnect

close

shutdown

deregister

register

write

writeAndFlush

newPromise

newSucceededFuture

newFailedFuture

newSucceededFuture