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

Modifier and Type	Class and Description
protected abstract class	AbstractChannel.AbstractUnsafe `Unsafe` implementation which sub-classes must extend and use.
private static class	AbstractChannel.AnnotatedConnectException
private static class	AbstractChannel.AnnotatedNoRouteToHostException
private static class	AbstractChannel.AnnotatedSocketException
pack-priv static class	AbstractChannel.CloseFuture

Modifier and Type	Field and Description
private final AbstractChannel.CloseFuture	closeFuture
private boolean	closeInitiated
private volatile EventLoop	eventLoop
private final ChannelId	id
private Throwable	initialCloseCause
private volatile SocketAddress	localAddress
private static final InternalLogger	logger
private final Channel	parent
private final DefaultChannelPipeline	pipeline
private volatile boolean	registered
private volatile SocketAddress	remoteAddress
private String	strVal
private boolean	strValActive Cache for the string representation of this channel
private final Channel.Unsafe	unsafe
private final VoidChannelPromise	unsafeVoidPromise

Access	Constructor and Description
protected	AbstractChannel(Channel the parent of this channel. `null` if there's no parent. parent) Creates a new instance.
protected	AbstractChannel(Channel the parent of this channel. `null` if there's no parent. parent, ChannelId id) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
public ByteBufAllocator	alloc() Implements io.netty.channel.Channel.alloc. Return the assigned `ByteBufAllocator` which will be used to allocate `ByteBuf`s.
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(SocketAddress localAddress, 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.
public long	bytesBeforeUnwritable() Implements io.netty.channel.Channel.bytesBeforeUnwritable. Get how many bytes can be written until `isWritable()` returns `false`.
public long	bytesBeforeWritable() Implements io.netty.channel.Channel.bytesBeforeWritable. Get how many bytes must be drained from underlying buffers until `isWritable()` returns `true`.
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(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	closeFuture() Implements io.netty.channel.Channel.closeFuture. Returns the `ChannelFuture` which will be notified when this channel is closed.
public final int	compareTo(Channel the object to be compared. o) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
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(SocketAddress remoteAddress, SocketAddress localAddress, 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(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(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.
protected abstract void	doBeginRead() Schedule a read operation.
protected abstract void	doBind(SocketAddress localAddress) Bind the `Channel` to the `SocketAddress`
protected abstract void	doClose() Close the `Channel`
protected void	doDeregister() Deregister the `Channel` from its `EventLoop`.
protected abstract void	doDisconnect() Disconnect this `Channel` from its remote peer
protected void	doRegister() Is called after the `Channel` is registered with its `EventLoop` as part of the register process.
protected void	doShutdownOutput() Called when conditions justify shutting down the output portion of the channel.
protected abstract void	doWrite(ChannelOutboundBuffer in) Flush the content of the given buffer to the remote peer.
public final boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Returns `true` if and only if the specified object is identical with this channel (i.e: `this == o`).
public EventLoop	eventLoop() Implements io.netty.channel.Channel.eventLoop. Return the `EventLoop` this `Channel` was registered to.
protected Object	filterOutboundMessage(Object msg) Invoked when a new message is added to a `ChannelOutboundBuffer` of this `AbstractChannel`, so that the `Channel` implementation converts the message to another.
public Channel	flush() Implements io.netty.channel.Channel.flush. Request to flush all pending messages via this ChannelOutboundInvoker.
public final int	hashCode() Overrides java.lang.Object.hashCode. Returns the ID of this channel.
public final ChannelId	id() Implements io.netty.channel.Channel.id. Returns the globally unique identifier of this `Channel`.
protected void	invalidateLocalAddress() Deprecated no use-case for this.
protected void	invalidateRemoteAddress() Deprecated no use-case for this.
protected abstract boolean	isCompatible(EventLoop loop) Return `true` if the given `EventLoop` is compatible with this instance.
public boolean	isRegistered() Implements io.netty.channel.Channel.isRegistered. Returns `true` if the `Channel` is registered with an `EventLoop`.
public boolean	isWritable() Implements io.netty.channel.Channel.isWritable. Returns `true` if and only if the I/O thread will perform the requested write operation immediately.
public SocketAddress	localAddress() Implements io.netty.channel.Channel.localAddress. Returns the local address where this channel is bound to.
protected abstract SocketAddress	localAddress0() Returns the `SocketAddress` which is bound locally.
protected final int	maxMessagesPerWrite()
protected DefaultChannelPipeline	newChannelPipeline() Returns a new `DefaultChannelPipeline` instance.
public ChannelFuture	newFailedFuture(Throwable cause) Implements io.netty.channel.ChannelOutboundInvoker.newFailedFuture. Create a new `ChannelFuture` which is marked as failed already.
protected ChannelId	newId() Returns a new `DefaultChannelId` instance.
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.
protected abstract AbstractChannel.AbstractUnsafe	newUnsafe() Create a new `AbstractUnsafe` instance which will be used for the life-time of the `Channel`
public Channel	parent() Implements io.netty.channel.Channel.parent. Returns the parent of this channel.
public ChannelPipeline	pipeline() Implements io.netty.channel.Channel.pipeline. Return the assigned `ChannelPipeline`.
public Channel	read() Implements io.netty.channel.Channel.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.
public SocketAddress	remoteAddress() Implements io.netty.channel.Channel.remoteAddress. Returns the remote address where this channel is connected to.
protected abstract SocketAddress	remoteAddress0() Return the `SocketAddress` which the `Channel` is connected to.
public String	toString() Overrides java.lang.Object.toString. Returns the `String` representation of this channel.
public Channel.Unsafe	unsafe() Implements io.netty.channel.Channel.unsafe. Returns an internal-use-only object that provides unsafe operations.
protected void	validateFileRegion(DefaultFileRegion region, long position)
public final 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(Object msg, ChannelPromise promise) Implements io.netty.channel.ChannelOutboundInvoker.write. Request to write a message via this `ChannelHandlerContext` through the `ChannelPipeline`.
public ChannelFuture	writeAndFlush(Object msg) Implements io.netty.channel.ChannelOutboundInvoker.writeAndFlush. Shortcut for call `write(Object)` and `flush()`.
public ChannelFuture	writeAndFlush(Object msg, ChannelPromise promise) Implements io.netty.channel.ChannelOutboundInvoker.writeAndFlush. Shortcut for call `write(Object, ChannelPromise)` and `flush()`.

Inherited from io.netty.util.DefaultAttributeMap:: attr hasAttr

public abstract Class AbstractChannel

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary