private static class CombinedChannelDuplexHandler.DelegatingChannelHandlerContext extends java.lang.Object implements ChannelHandlerContext
| Modifier and Type | Field and Description |
|---|---|
private ChannelHandlerContext |
ctx |
private ChannelHandler |
handler |
(package private) boolean |
removed |
| Constructor and Description |
|---|
DelegatingChannelHandlerContext(ChannelHandlerContext ctx,
ChannelHandler handler) |
| Modifier and Type | Method and Description |
|---|---|
ByteBufAllocator |
alloc()
Return the assigned
ByteBufAllocator which will be used to allocate ByteBufs. |
<T> Attribute<T> |
attr(AttributeKey<T> key)
Get the
Attribute for the given AttributeKey. |
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. |
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()
|
ChannelHandlerContext |
fireChannelUnregistered()
|
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.
|
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. |
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. |
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. |
(package private) void |
remove() |
private void |
remove0() |
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. |
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(). |
private final ChannelHandlerContext ctx
private final ChannelHandler handler
boolean removed
DelegatingChannelHandlerContext(ChannelHandlerContext ctx, ChannelHandler handler)
public Channel channel()
ChannelHandlerContextChannel which is bound to the ChannelHandlerContext.channel in interface ChannelHandlerContextpublic EventExecutor executor()
ChannelHandlerContextEventExecutor 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.executor in interface ChannelHandlerContextpublic java.lang.String name()
ChannelHandlerContextChannelHandlerContext.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.name in interface ChannelHandlerContextpublic ChannelHandler handler()
ChannelHandlerContextChannelHandler that is bound this ChannelHandlerContext.handler in interface ChannelHandlerContextpublic boolean isRemoved()
ChannelHandlerContexttrue 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.isRemoved in interface ChannelHandlerContextpublic ChannelHandlerContext fireChannelRegistered()
ChannelHandlerContextChannel 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.fireChannelRegistered in interface ChannelHandlerContextpublic ChannelHandlerContext fireChannelUnregistered()
ChannelHandlerContextChannel 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.fireChannelUnregistered in interface ChannelHandlerContextpublic ChannelHandlerContext fireChannelActive()
ChannelHandlerContextChannel 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.fireChannelActive in interface ChannelHandlerContextpublic ChannelHandlerContext fireChannelInactive()
ChannelHandlerContextChannel 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.fireChannelInactive in interface ChannelHandlerContextpublic ChannelHandlerContext fireExceptionCaught(java.lang.Throwable cause)
ChannelHandlerContextChannel 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.fireExceptionCaught in interface ChannelHandlerContextpublic ChannelHandlerContext fireUserEventTriggered(java.lang.Object event)
ChannelHandlerContextChannel 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.fireUserEventTriggered in interface ChannelHandlerContextpublic ChannelHandlerContext fireChannelRead(java.lang.Object msg)
ChannelHandlerContextChannel 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.fireChannelRead in interface ChannelHandlerContextpublic ChannelHandlerContext fireChannelReadComplete()
ChannelHandlerContextChannelInboundHandler.channelReadComplete(ChannelHandlerContext)
event to the next ChannelInboundHandler in the ChannelPipeline.fireChannelReadComplete in interface ChannelHandlerContextpublic ChannelHandlerContext fireChannelWritabilityChanged()
ChannelHandlerContextChannelInboundHandler.channelWritabilityChanged(ChannelHandlerContext)
event to the next ChannelInboundHandler in the ChannelPipeline.fireChannelWritabilityChanged in interface ChannelHandlerContextpublic ChannelFuture bind(java.net.SocketAddress localAddress)
ChannelHandlerContextSocketAddress 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.
bind in interface ChannelHandlerContextpublic ChannelFuture connect(java.net.SocketAddress remoteAddress)
ChannelHandlerContextSocketAddress 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.
connect in interface ChannelHandlerContextpublic ChannelFuture connect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress)
ChannelHandlerContextSocketAddress 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.
connect in interface ChannelHandlerContextpublic ChannelFuture disconnect()
ChannelHandlerContextChannelFuture 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.
disconnect in interface ChannelHandlerContextpublic ChannelFuture close()
ChannelHandlerContextChannel 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.
close in interface ChannelHandlerContextpublic ChannelFuture deregister()
ChannelHandlerContextEventExecutor 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.
deregister in interface ChannelHandlerContextpublic ChannelFuture bind(java.net.SocketAddress localAddress, ChannelPromise promise)
ChannelHandlerContextSocketAddress 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.
bind in interface ChannelHandlerContextpublic ChannelFuture connect(java.net.SocketAddress remoteAddress, ChannelPromise promise)
ChannelHandlerContextSocketAddress 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.
connect in interface ChannelHandlerContextpublic ChannelFuture connect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress, ChannelPromise promise)
ChannelHandlerContextSocketAddress 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.
connect in interface ChannelHandlerContextpublic ChannelFuture disconnect(ChannelPromise promise)
ChannelHandlerContextChannelFuture 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.
disconnect in interface ChannelHandlerContextpublic ChannelFuture close(ChannelPromise promise)
ChannelHandlerContextChannel 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.
close in interface ChannelHandlerContextpublic ChannelFuture deregister(ChannelPromise promise)
ChannelHandlerContextEventExecutor 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.
deregister in interface ChannelHandlerContextpublic ChannelHandlerContext read()
ChannelHandlerContextChannel 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.
read in interface ChannelHandlerContextpublic ChannelFuture write(java.lang.Object msg)
ChannelHandlerContextChannelHandlerContext 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.write in interface ChannelHandlerContextpublic ChannelFuture write(java.lang.Object msg, ChannelPromise promise)
ChannelHandlerContextChannelHandlerContext 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.write in interface ChannelHandlerContextpublic ChannelHandlerContext flush()
ChannelHandlerContextflush in interface ChannelHandlerContextpublic ChannelFuture writeAndFlush(java.lang.Object msg, ChannelPromise promise)
ChannelHandlerContextChannelHandlerContext.write(Object, ChannelPromise) and ChannelHandlerContext.flush().writeAndFlush in interface ChannelHandlerContextpublic ChannelFuture writeAndFlush(java.lang.Object msg)
ChannelHandlerContextChannelHandlerContext.write(Object) and ChannelHandlerContext.flush().writeAndFlush in interface ChannelHandlerContextpublic ChannelPipeline pipeline()
ChannelHandlerContextChannelPipelinepipeline in interface ChannelHandlerContextpublic ByteBufAllocator alloc()
ChannelHandlerContextByteBufAllocator which will be used to allocate ByteBufs.alloc in interface ChannelHandlerContextpublic ChannelPromise newPromise()
ChannelHandlerContextChannelPromise.newPromise in interface ChannelHandlerContextpublic ChannelProgressivePromise newProgressivePromise()
ChannelHandlerContextChannelProgressivePromisenewProgressivePromise in interface ChannelHandlerContextpublic ChannelFuture newSucceededFuture()
ChannelHandlerContextChannelFuture 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.newSucceededFuture in interface ChannelHandlerContextpublic ChannelFuture newFailedFuture(java.lang.Throwable cause)
ChannelHandlerContextChannelFuture 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.newFailedFuture in interface ChannelHandlerContextpublic ChannelPromise voidPromise()
ChannelHandlerContext
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.
voidPromise in interface ChannelHandlerContextpublic <T> Attribute<T> attr(AttributeKey<T> key)
AttributeMapAttribute for the given AttributeKey. This method will never return null, but may return
an Attribute which does not have a value set yet.attr in interface AttributeMapfinal void remove()
private void remove0()