Netty/Transport 4.1.107.Final · io.netty.channel.AbstractChannelHandlerContext

Modifier and Type	Class and Description
private static class	AbstractChannelHandlerContext.Tasks
pack-priv static class	AbstractChannelHandlerContext.WriteTask

Modifier and Type	Field and Description
private static final int	ADD_COMPLETE `ChannelHandler#handlerAdded(ChannelHandlerContext)` was called.
private static final int	ADD_PENDING `ChannelHandler#handlerAdded(ChannelHandlerContext)` is about to be called.
private final int	executionMask
pack-priv final EventExecutor	executor
private static final AtomicIntegerFieldUpdater<AbstractChannelHandlerContext>	HANDLER_STATE_UPDATER
private volatile int	handlerState
private static final int	INIT Neither `ChannelHandler#handlerAdded(ChannelHandlerContext)` nor `ChannelHandler#handlerRemoved(ChannelHandlerContext)` was called.
private AbstractChannelHandlerContext.Tasks	invokeTasks
private static final InternalLogger	logger
private final String	name
pack-priv volatile AbstractChannelHandlerContext	next
private final boolean	ordered
private final DefaultChannelPipeline	pipeline
pack-priv volatile AbstractChannelHandlerContext	prev
private static final int	REMOVE_COMPLETE `ChannelHandler#handlerRemoved(ChannelHandlerContext)` was called.
private ChannelFuture	succeededFuture

Access	Constructor and Description
pack-priv	AbstractChannelHandlerContext(DefaultChannelPipeline pipeline, EventExecutor executor, String name, Class<? extends ChannelHandler> handlerClass)

Method Summary

Modifier and Type	Method and Description
public ByteBufAllocator	alloc() Implements io.netty.channel.ChannelHandlerContext.alloc. Return the assigned `ByteBufAllocator` which will be used to allocate `ByteBuf`s.
public <T> Attribute<T>	attr(AttributeKey<T> key) Implements io.netty.channel.ChannelHandlerContext.attr. Get the `Attribute` for the given `AttributeKey`.
public ChannelFuture	bind(SocketAddress localAddress) Implements io.netty.channel.ChannelOutboundInvoker.bind. 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.
public ChannelFuture	bind(final SocketAddress localAddress, final ChannelPromise promise) Implements io.netty.channel.ChannelOutboundInvoker.bind. 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.
pack-priv final void	callHandlerAdded()
pack-priv final void	callHandlerRemoved()
public Channel	channel() Implements io.netty.channel.ChannelHandlerContext.channel. Return the `Channel` which is bound to the `ChannelHandlerContext`.
public ChannelFuture	close() Implements io.netty.channel.ChannelOutboundInvoker.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.
public ChannelFuture	close(final ChannelPromise promise) Implements io.netty.channel.ChannelOutboundInvoker.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.
public ChannelFuture	connect(SocketAddress remoteAddress) Implements io.netty.channel.ChannelOutboundInvoker.connect. 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.
public ChannelFuture	connect(SocketAddress remoteAddress, SocketAddress localAddress) Implements io.netty.channel.ChannelOutboundInvoker.connect. 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.
public ChannelFuture	connect(SocketAddress remoteAddress, ChannelPromise promise) Implements io.netty.channel.ChannelOutboundInvoker.connect. 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.
public ChannelFuture	connect(final SocketAddress remoteAddress, final SocketAddress localAddress, final ChannelPromise promise) Implements io.netty.channel.ChannelOutboundInvoker.connect. 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.
public ChannelFuture	deregister() Implements io.netty.channel.ChannelOutboundInvoker.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.
public ChannelFuture	deregister(final ChannelPromise promise) Implements io.netty.channel.ChannelOutboundInvoker.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.
public ChannelFuture	disconnect() Implements io.netty.channel.ChannelOutboundInvoker.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.
public ChannelFuture	disconnect(final ChannelPromise promise) Implements io.netty.channel.ChannelOutboundInvoker.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.
public EventExecutor	executor() Implements io.netty.channel.ChannelHandlerContext.executor. Returns the `EventExecutor` which is used to execute an arbitrary task.
private AbstractChannelHandlerContext	findContextInbound(int mask)
private AbstractChannelHandlerContext	findContextOutbound(int mask)
public ChannelHandlerContext	fireChannelActive() Implements io.netty.channel.ChannelHandlerContext.fireChannelActive. A `Channel` is active now, which means it is connected.
public ChannelHandlerContext	fireChannelInactive() Implements io.netty.channel.ChannelHandlerContext.fireChannelInactive. A `Channel` is inactive now, which means it is closed.
public ChannelHandlerContext	fireChannelRead(final Object msg) Implements io.netty.channel.ChannelHandlerContext.fireChannelRead. A `Channel` received a message.
public ChannelHandlerContext	fireChannelReadComplete() Implements io.netty.channel.ChannelHandlerContext.fireChannelReadComplete. Triggers an `ChannelInboundHandler#channelReadComplete(ChannelHandlerContext)` event to the next `ChannelInboundHandler` in the `ChannelPipeline`.
public ChannelHandlerContext	fireChannelRegistered() Implements io.netty.channel.ChannelHandlerContext.fireChannelRegistered. A `Channel` was registered to its `EventLoop`.
public ChannelHandlerContext	fireChannelUnregistered() Implements io.netty.channel.ChannelHandlerContext.fireChannelUnregistered. A `Channel` was unregistered from its `EventLoop`.
public ChannelHandlerContext	fireChannelWritabilityChanged() Implements io.netty.channel.ChannelHandlerContext.fireChannelWritabilityChanged. Triggers an `ChannelInboundHandler#channelWritabilityChanged(ChannelHandlerContext)` event to the next `ChannelInboundHandler` in the `ChannelPipeline`.
public ChannelHandlerContext	fireExceptionCaught(final Throwable cause) Implements io.netty.channel.ChannelHandlerContext.fireExceptionCaught. A `Channel` received an `Throwable` in one of its inbound operations.
public ChannelHandlerContext	fireUserEventTriggered(final Object event) Implements io.netty.channel.ChannelHandlerContext.fireUserEventTriggered. A `Channel` received an user defined event.
public ChannelHandlerContext	flush() Implements io.netty.channel.ChannelHandlerContext.flush. Request to flush all pending messages via this ChannelOutboundInvoker.
public <T> boolean	hasAttr(AttributeKey<T> key) Implements io.netty.channel.ChannelHandlerContext.hasAttr. Returns `true` if and only if the given `Attribute` exists in this `AttributeMap`.
private void	invokeBind(SocketAddress localAddress, ChannelPromise promise)
pack-priv static void	invokeChannelActive(final AbstractChannelHandlerContext next)
private void	invokeChannelActive()
pack-priv static void	invokeChannelInactive(final AbstractChannelHandlerContext next)
private void	invokeChannelInactive()
pack-priv static void	invokeChannelRead(final AbstractChannelHandlerContext next, Object msg)
private void	invokeChannelRead(Object msg)
pack-priv static void	invokeChannelReadComplete(final AbstractChannelHandlerContext next)
private void	invokeChannelReadComplete()
pack-priv static void	invokeChannelRegistered(final AbstractChannelHandlerContext next)
private void	invokeChannelRegistered()
pack-priv static void	invokeChannelUnregistered(final AbstractChannelHandlerContext next)
private void	invokeChannelUnregistered()
pack-priv static void	invokeChannelWritabilityChanged(final AbstractChannelHandlerContext next)
private void	invokeChannelWritabilityChanged()
private void	invokeClose(ChannelPromise promise)
private void	invokeConnect(SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise)
private void	invokeDeregister(ChannelPromise promise)
private void	invokeDisconnect(ChannelPromise promise)
pack-priv static void	invokeExceptionCaught(final AbstractChannelHandlerContext next, final Throwable cause)
private void	invokeExceptionCaught(final 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()
pack-priv static void	invokeUserEventTriggered(final AbstractChannelHandlerContext next, final Object event)
private void	invokeUserEventTriggered(Object event)
pack-priv void	invokeWrite(Object msg, ChannelPromise promise)
private void	invokeWrite0(Object msg, ChannelPromise promise)
pack-priv void	invokeWriteAndFlush(Object msg, ChannelPromise promise)
private boolean	isNotValidPromise(ChannelPromise promise, boolean allowVoidPromise)
public boolean	isRemoved() Implements io.netty.channel.ChannelHandlerContext.isRemoved. Return `true` if the `ChannelHandler` which belongs to this context was removed from the `ChannelPipeline`.
public String	name() Implements io.netty.channel.ChannelHandlerContext.name. The unique name of the `ChannelHandlerContext`.The name was used when then `ChannelHandler` was added to the `ChannelPipeline`.
public ChannelFuture	newFailedFuture(Throwable cause) Implements io.netty.channel.ChannelOutboundInvoker.newFailedFuture. Create a new `ChannelFuture` which is marked as failed already.
public ChannelProgressivePromise	newProgressivePromise() Implements io.netty.channel.ChannelOutboundInvoker.newProgressivePromise. Return an new `ChannelProgressivePromise`
public ChannelPromise	newPromise() Implements io.netty.channel.ChannelOutboundInvoker.newPromise. Return a new `ChannelPromise`.
public ChannelFuture	newSucceededFuture() Implements io.netty.channel.ChannelOutboundInvoker.newSucceededFuture. Create a new `ChannelFuture` which is marked as succeeded already.
private static void	notifyOutboundHandlerException(Throwable cause, ChannelPromise promise)
public ChannelPipeline	pipeline() Implements io.netty.channel.ChannelHandlerContext.pipeline. Return the assigned `ChannelPipeline`
public ChannelHandlerContext	read() Implements io.netty.channel.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 boolean	safeExecute(EventExecutor executor, Runnable runnable, ChannelPromise promise, Object msg, boolean lazy)
pack-priv final boolean	setAddComplete()
pack-priv final void	setAddPending()
pack-priv final void	setRemoved()
private static boolean	skipContext(AbstractChannelHandlerContext ctx, EventExecutor currentExecutor, int mask, int onlyMask)
public String	toHintString() Implements io.netty.util.ResourceLeakHint.toHintString. Returns a human-readable message that potentially enables easier resource leak tracking.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public ChannelPromise	voidPromise() Implements io.netty.channel.ChannelOutboundInvoker.voidPromise. Return a special ChannelPromise which can be reused for different operations.
public ChannelFuture	write(Object msg) Implements io.netty.channel.ChannelOutboundInvoker.write. Request to write a message via this `ChannelHandlerContext` through the `ChannelPipeline`.
public ChannelFuture	write(final Object msg, final ChannelPromise promise) Implements io.netty.channel.ChannelOutboundInvoker.write. Request to write a message via this `ChannelHandlerContext` through the `ChannelPipeline`.
private void	write(Object msg, boolean flush, ChannelPromise promise)
public ChannelFuture	writeAndFlush(Object msg, ChannelPromise promise) Implements io.netty.channel.ChannelOutboundInvoker.writeAndFlush. Shortcut for call `write(Object, ChannelPromise)` and `flush()`.
public ChannelFuture	writeAndFlush(Object msg) Implements io.netty.channel.ChannelOutboundInvoker.writeAndFlush. Shortcut for call `write(Object)` and `flush()`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

pack-priv abstract Class AbstractChannelHandlerContext

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary