Netty 5.0.0.Alpha5 · io.netty5.channel.DefaultChannelHandlerContext

Modifier and Type	Class and Description
pack-priv abstract static class	DefaultChannelHandlerContext.AbstractWriteTask
private static class	DefaultChannelHandlerContext.DefaultChannelHandlerContextAwareEventExecutor
private static class	DefaultChannelHandlerContext.Tasks
pack-priv static class	DefaultChannelHandlerContext.WriteAndFlushTask
pack-priv static class	DefaultChannelHandlerContext.WriteTask

Modifier and Type	Field and Description
private static final int	ADD_COMPLETE `ChannelHandler#handlerAdded(ChannelHandlerContext)` was called.
private long	currentPendingBytes
private static final boolean	ESTIMATE_TASK_SIZE_ON_SUBMIT
private final int	executionMask
private final DefaultChannelHandlerContext.DefaultChannelHandlerContextAwareEventExecutor	executor
private final ChannelHandler	handler
private int	handlerState
private static final int	INIT Neither `ChannelHandler#handlerAdded(ChannelHandlerContext)` nor `ChannelHandler#handlerRemoved(ChannelHandlerContext)` was called.
private DefaultChannelHandlerContext.Tasks	invokeTasks
private static final InternalLogger	logger
private final String	name
pack-priv DefaultChannelHandlerContext	next
private final DefaultChannelPipeline	pipeline
pack-priv DefaultChannelHandlerContext	prev
private static final int	REMOVE_COMPLETE `ChannelHandler#handlerRemoved(ChannelHandlerContext)` was called.
private static final int	REMOVE_STARTED `ChannelHandler#handlerRemoved(ChannelHandlerContext)` is about to be called.
private volatile boolean	removed
private static final int	WRITE_TASK_OVERHEAD

Access	Constructor and Description
pack-priv	DefaultChannelHandlerContext(DefaultChannelPipeline pipeline, String name, ChannelHandler handler)

Method Summary

Modifier and Type	Method and Description
public Future<Void>	bind(SocketAddress localAddress) Implements io.netty5.channel.ChannelOutboundInvoker.bind. 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.
pack-priv void	callHandlerAdded()
pack-priv void	callHandlerRemoved()
public Future<Void>	close() Implements io.netty5.channel.ChannelOutboundInvoker.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.
public Future<Void>	connect(SocketAddress remoteAddress) Implements io.netty5.channel.ChannelOutboundInvoker.connect. 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.
public Future<Void>	connect(final SocketAddress remoteAddress, final SocketAddress localAddress) Implements io.netty5.channel.ChannelOutboundInvoker.connect. 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.
public Future<Void>	deregister() Implements io.netty5.channel.ChannelOutboundInvoker.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.
public Future<Void>	disconnect() Implements io.netty5.channel.ChannelOutboundInvoker.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.
public EventExecutor	executor() Implements io.netty5.channel.ChannelOutboundInvoker.executor. Returns the `EventExecutor` that is used to execute the operations of this `ChannelOutboundInvoker`.
private static Future<Void>	failRemoved(DefaultChannelHandlerContext ctx)
private Future<Void>	findAndInvokeBind(SocketAddress localAddress)
private void	findAndInvokeChannelActive()
private void	findAndInvokeChannelExceptionCaught(Throwable cause)
private void	findAndInvokeChannelInactive()
private void	findAndInvokeChannelInboundEvent(Object event)
private void	findAndInvokeChannelRead(Object msg)
private void	findAndInvokeChannelReadComplete()
private void	findAndInvokeChannelRegistered()
private void	findAndInvokeChannelShutdown(ChannelShutdownDirection direction)
private void	findAndInvokeChannelUnregistered()
private void	findAndInvokeChannelWritabilityChanged()
private Future<Void>	findAndInvokeClose()
private Future<Void>	findAndInvokeConnect(SocketAddress remoteAddress, SocketAddress localAddress)
private Future<Void>	findAndInvokeDeregister()
private Future<Void>	findAndInvokeDisconnect()
private void	findAndInvokeFlush()
private void	findAndInvokeRead()
private void	findAndInvokeRead(ReadBufferAllocator allocator)
private Future<Void>	findAndInvokeRegister()
private Future<Void>	findAndInvokeSendOutboundEvent(Object event)
private Future<Void>	findAndInvokeShutdown(ChannelShutdownDirection direction)
private DefaultChannelHandlerContext	findContextInbound(int mask)
private DefaultChannelHandlerContext	findContextOutbound(int mask)
public ChannelHandlerContext	fireChannelActive() Implements io.netty5.channel.ChannelHandlerContext.fireChannelActive. A `Channel` is active now, which means it is connected.
public ChannelHandlerContext	fireChannelExceptionCaught(Throwable cause) Implements io.netty5.channel.ChannelHandlerContext.fireChannelExceptionCaught. A `Channel` received an `Throwable` in one of its inbound operations.
public ChannelHandlerContext	fireChannelInactive() Implements io.netty5.channel.ChannelHandlerContext.fireChannelInactive. A `Channel` is inactive now, which means it is closed.
public ChannelHandlerContext	fireChannelInboundEvent(Object event) Implements io.netty5.channel.ChannelHandlerContext.fireChannelInboundEvent. A `Channel` received a custom defined inbound event.
public ChannelHandlerContext	fireChannelRead(final Object msg) Implements io.netty5.channel.ChannelHandlerContext.fireChannelRead. A `Channel` received a message.
public ChannelHandlerContext	fireChannelReadComplete() Implements io.netty5.channel.ChannelHandlerContext.fireChannelReadComplete. Triggers an `ChannelHandler#channelReadComplete(ChannelHandlerContext)` event to the next `ChannelHandler` in the `ChannelPipeline`.
public ChannelHandlerContext	fireChannelRegistered() Implements io.netty5.channel.ChannelHandlerContext.fireChannelRegistered. A `Channel` was registered to its `EventLoop`.
public ChannelHandlerContext	fireChannelShutdown(ChannelShutdownDirection direction) Implements io.netty5.channel.ChannelHandlerContext.fireChannelShutdown. A `Channel` was shutdown in a specific direction.
public ChannelHandlerContext	fireChannelUnregistered() Implements io.netty5.channel.ChannelHandlerContext.fireChannelUnregistered. A `Channel` was unregistered from its `EventLoop`.
public ChannelHandlerContext	fireChannelWritabilityChanged() Implements io.netty5.channel.ChannelHandlerContext.fireChannelWritabilityChanged. Triggers an `ChannelHandler#channelWritabilityChanged(ChannelHandlerContext)` event to the next `ChannelHandler` in the `ChannelPipeline`.
public ChannelHandlerContext	flush() Implements io.netty5.channel.ChannelHandlerContext.flush. Request to flush all pending messages via this ChannelOutboundInvoker.
private Future<Void>	handleOutboundHandlerException(Throwable cause, boolean closeDidThrow)
public ChannelHandler	handler() Implements io.netty5.channel.ChannelHandlerContext.handler. The `ChannelHandler` that is bound this `ChannelHandlerContext`.
private static boolean	handlesPendingOutboundBytes(int mask)
private Future<Void>	invokeBind(SocketAddress localAddress)
pack-priv void	invokeChannelActive()
pack-priv void	invokeChannelExceptionCaught(final Throwable cause)
pack-priv void	invokeChannelInactive()
pack-priv void	invokeChannelInboundEvent(Object event)
pack-priv void	invokeChannelRead(Object msg)
pack-priv void	invokeChannelReadComplete()
pack-priv void	invokeChannelRegistered()
pack-priv void	invokeChannelShutdown(ChannelShutdownDirection direction)
pack-priv void	invokeChannelUnregistered()
pack-priv void	invokeChannelWritabilityChanged()
private Future<Void>	invokeClose()
private Future<Void>	invokeConnect(SocketAddress remoteAddress, SocketAddress localAddress)
private Future<Void>	invokeDeregister()
private Future<Void>	invokeDisconnect()
private void	invokeFlush()
private void	invokeRead(ReadBufferAllocator allocator)
private Future<Void>	invokeRegister()
private Future<Void>	invokeSendOutboundEvent(Object event)
private Future<Void>	invokeShutdown(ChannelShutdownDirection direction)
private DefaultChannelHandlerContext.Tasks	invokeTasks()
private Future<Void>	invokeWrite(Object msg)
private Future<Void>	invokeWriteAndFlush(Object msg)
public boolean	isRemoved() Implements io.netty5.channel.ChannelHandlerContext.isRemoved. Return `true` if the `ChannelHandler` which belongs to this context was removed from the `ChannelPipeline`.
public String	name() Implements io.netty5.channel.ChannelHandlerContext.name. The unique name of the `ChannelHandlerContext`.The name was used when then `ChannelHandler` was added to the `ChannelPipeline`.
private static ChannelPipelineException	newRemovedException(ChannelHandlerContext ctx, Throwable cause)
private void	notifyHandlerRemovedAlready()
private void	notifyHandlerRemovedAlready(Throwable cause)
private EventExecutor	originalExecutor()
private long	pendingOutboundBytes()
public ChannelPipeline	pipeline() Implements io.netty5.channel.ChannelHandlerContext.pipeline. Return the assigned `ChannelPipeline`
public ChannelHandlerContext	read() Implements io.netty5.channel.ChannelHandlerContext.read.
public ChannelHandlerContext	read(ReadBufferAllocator The `ReadBufferAllocator` that should be used to allocate a `Buffer` if needed (for reading the data). readBufferAllocator) Implements io.netty5.channel.ChannelHandlerContext.read. Request to read data from the `Channel`, triggers an `ChannelHandler#channelRead(ChannelHandlerContext, Object)` event if data was read, and triggers a `channelReadComplete` event so the handler can decide to continue reading.
public Future<Void>	register() Implements io.netty5.channel.ChannelOutboundInvoker.register. Request to register on the `EventExecutor` for I/O processing.
pack-priv void	remove(boolean relink)
pack-priv static boolean	safeExecute(EventExecutor executor, Runnable runnable, Promise<Void> promise, Object msg)
private IllegalStateException	saveCurrentPendingBytesIfNeeded()
private boolean	saveCurrentPendingBytesIfNeededInbound()
private Future<Void>	saveCurrentPendingBytesIfNeededOutbound()
public Future<Void>	sendOutboundEvent(Object event) Implements io.netty5.channel.ChannelOutboundInvoker.sendOutboundEvent. Send a custom outbound event via this `ChannelOutboundInvoker` through the `ChannelPipeline`.
pack-priv boolean	setAddComplete()
public Future<Void>	shutdown(ChannelShutdownDirection direction) Implements io.netty5.channel.ChannelOutboundInvoker.shutdown. 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.
public String	toHintString() Implements io.netty5.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.
private void	updatePendingBytesIfNeeded()
public Future<Void>	write(Object msg) Implements io.netty5.channel.ChannelOutboundInvoker.write. Request to write a message via this `ChannelHandlerContext` through the `ChannelPipeline`.
private Future<Void>	write(Object msg, boolean flush)
public Future<Void>	writeAndFlush(Object msg) Implements io.netty5.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 final Class DefaultChannelHandlerContext

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary