Package io.netty.channel

Class CombinedChannelDuplexHandler.DelegatingChannelHandlerContext

java.lang.Object

io.netty.channel.CombinedChannelDuplexHandler.DelegatingChannelHandlerContext

All Implemented Interfaces:

ChannelHandlerContext, ChannelInboundInvoker, ChannelOutboundInvoker, AttributeMap

Enclosing class:

CombinedChannelDuplexHandler<I extends ChannelInboundHandler,O extends ChannelOutboundHandler>

private static class CombinedChannelDuplexHandler.DelegatingChannelHandlerContext
extends Object
implements ChannelHandlerContext

Field Summary

Fields

Modifier and Type	Field	Description
private final ChannelHandlerContext	ctx
private final ChannelHandler	handler
(package private) boolean	removed

Constructor Summary

Constructors

Constructor	Description
DelegatingChannelHandlerContext(ChannelHandlerContext ctx, ChannelHandler handler)

Method Summary

Modifier and Type	Method	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(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(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(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(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(SocketAddress remoteAddress, 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(SocketAddress remoteAddress, 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()	Returns the EventExecutor which is used to execute an arbitrary task.
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(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(Throwable cause)	A Channel received an Throwable in one of its inbound operations.
ChannelHandlerContext	fireUserEventTriggered(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.
<T> boolean	hasAttr(AttributeKey<T> key)	Returns true if and only if the given Attribute exists in this AttributeMap.
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.
ChannelFuture	newFailedFuture(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) final void	remove()
private void	remove0()
ChannelPromise	voidPromise()	Return a special ChannelPromise which can be reused for different operations.
ChannelFuture	write(Object msg)	Request to write a message via this ChannelHandlerContext through the ChannelPipeline.
ChannelFuture	write(Object msg, ChannelPromise promise)	Request to write a message via this ChannelHandlerContext through the ChannelPipeline.
ChannelFuture	writeAndFlush(Object msg)	Shortcut for call ChannelOutboundInvoker.write(Object) and ChannelOutboundInvoker.flush().
ChannelFuture	writeAndFlush(Object msg, ChannelPromise promise)	Shortcut for call ChannelOutboundInvoker.write(Object, ChannelPromise) and ChannelOutboundInvoker.flush().

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ctx

private final ChannelHandlerContext ctx

handler

private final ChannelHandler handler

removed

boolean removed

Constructor Details

DelegatingChannelHandlerContext

DelegatingChannelHandlerContext(ChannelHandlerContext ctx,
 ChannelHandler handler)

Method Details

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: ChannelHandlerContext

Returns the EventExecutor which is used to execute an arbitrary task.

Specified by:

executor in interface ChannelHandlerContext

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. Note that this method is only meant to be called from with in the EventLoop.

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 ChannelInboundHandler.channelRegistered(ChannelHandlerContext) method called of the next ChannelInboundHandler 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 ChannelInboundHandler.channelUnregistered(ChannelHandlerContext) method called of the next ChannelInboundHandler 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 ChannelInboundHandler.channelActive(ChannelHandlerContext) method called of the next ChannelInboundHandler 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 ChannelInboundHandler.channelInactive(ChannelHandlerContext) method called of the next ChannelInboundHandler contained in the ChannelPipeline of the Channel.

Specified by:

fireChannelInactive in interface ChannelHandlerContext

Specified by:

fireChannelInactive in interface ChannelInboundInvoker

fireExceptionCaught

public ChannelHandlerContext fireExceptionCaught(Throwable cause)

Description copied from interface: ChannelInboundInvoker

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

Specified by:

fireExceptionCaught in interface ChannelInboundInvoker

fireUserEventTriggered

public ChannelHandlerContext fireUserEventTriggered(Object event)

Description copied from interface: ChannelInboundInvoker

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

Specified by:

fireUserEventTriggered 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 ChannelInboundHandler.channelRead(ChannelHandlerContext, Object) method called of the next ChannelInboundHandler 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 ChannelInboundHandler.channelReadComplete(ChannelHandlerContext) event to the next ChannelInboundHandler 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 ChannelInboundHandler.channelWritabilityChanged(ChannelHandlerContext) event to the next ChannelInboundHandler in the ChannelPipeline.

Specified by:

fireChannelWritabilityChanged in interface ChannelHandlerContext

Specified by:

fireChannelWritabilityChanged in interface ChannelInboundInvoker

bind

public ChannelFuture bind(SocketAddress localAddress)

Description copied from interface: ChannelOutboundInvoker

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 ChannelOutboundInvoker

connect

public ChannelFuture connect(SocketAddress remoteAddress)

Description copied from interface: ChannelOutboundInvoker

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 ChannelOutboundInvoker

connect

public ChannelFuture 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 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 ChannelOutboundInvoker

disconnect

public ChannelFuture disconnect()

Description copied from interface: ChannelOutboundInvoker

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 ChannelOutboundInvoker

close

public ChannelFuture close()

Description copied from interface: ChannelOutboundInvoker

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 ChannelOutboundInvoker

deregister

public ChannelFuture deregister()

Description copied from interface: ChannelOutboundInvoker

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 ChannelOutboundInvoker

bind

public ChannelFuture bind(SocketAddress localAddress,
 ChannelPromise promise)

Description copied from interface: ChannelOutboundInvoker

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 ChannelOutboundInvoker

connect

public ChannelFuture connect(SocketAddress remoteAddress,
 ChannelPromise promise)

Description copied from interface: ChannelOutboundInvoker

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 ChannelOutboundInvoker

connect

public ChannelFuture connect(SocketAddress remoteAddress,
 SocketAddress localAddress,
 ChannelPromise promise)

Description copied from interface: ChannelOutboundInvoker

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 ChannelOutboundInvoker

disconnect

public ChannelFuture disconnect(ChannelPromise promise)

Description copied from interface: ChannelOutboundInvoker

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 ChannelOutboundInvoker

close

public ChannelFuture close(ChannelPromise promise)

Description copied from interface: ChannelOutboundInvoker

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 ChannelOutboundInvoker

deregister

public ChannelFuture deregister(ChannelPromise promise)

Description copied from interface: ChannelOutboundInvoker

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 ChannelOutboundInvoker

read

public ChannelHandlerContext read()

Description copied from interface: ChannelOutboundInvoker

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

Specified by:

read in interface ChannelOutboundInvoker

write

public ChannelFuture 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

write

public ChannelFuture write(Object msg,
 ChannelPromise promise)

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

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

writeAndFlush

public ChannelFuture writeAndFlush(Object msg,
 ChannelPromise promise)

Description copied from interface: ChannelOutboundInvoker

Shortcut for call ChannelOutboundInvoker.write(Object, ChannelPromise) and ChannelOutboundInvoker.flush().

Specified by:

writeAndFlush in interface ChannelOutboundInvoker

writeAndFlush

public ChannelFuture writeAndFlush(Object msg)

Description copied from interface: ChannelOutboundInvoker

Shortcut for call ChannelOutboundInvoker.write(Object) and ChannelOutboundInvoker.flush().

Specified by:

writeAndFlush in interface ChannelOutboundInvoker

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

newPromise

public ChannelPromise newPromise()

Description copied from interface: ChannelOutboundInvoker

Return a new ChannelPromise.

Specified by:

newPromise in interface ChannelOutboundInvoker

newProgressivePromise

public ChannelProgressivePromise newProgressivePromise()

Description copied from interface: ChannelOutboundInvoker

Return an new ChannelProgressivePromise

Specified by:

newProgressivePromise in interface ChannelOutboundInvoker

newSucceededFuture

public ChannelFuture newSucceededFuture()

Description copied from interface: ChannelOutboundInvoker

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 ChannelOutboundInvoker

newFailedFuture

public ChannelFuture newFailedFuture(Throwable cause)

Description copied from interface: ChannelOutboundInvoker

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 ChannelOutboundInvoker

voidPromise

public ChannelPromise voidPromise()

Description copied from interface: ChannelOutboundInvoker

Return a special ChannelPromise which can be reused for different operations.

It's only supported to use it for ChannelOutboundInvoker.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 ChannelOutboundInvoker

attr

public <T> Attribute<T> attr(AttributeKey<T> key)

Description copied from interface: AttributeMap

Get the Attribute for the given AttributeKey. This method will never return null, but may return an Attribute which does not have a value set yet.

Specified by:

attr in interface AttributeMap

Specified by:

attr in interface ChannelHandlerContext

hasAttr

public <T> boolean hasAttr(AttributeKey<T> key)

Description copied from interface: AttributeMap

Returns true if and only if the given Attribute exists in this AttributeMap.

Specified by:

hasAttr in interface AttributeMap

Specified by:

hasAttr in interface ChannelHandlerContext

remove

final void remove()

remove0

private void remove0()