Class AbstractNioMessageChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.nio.AbstractNioChannel

io.netty.channel.nio.AbstractNioMessageChannel

All Implemented Interfaces:

Channel, ChannelOutboundInvoker, AttributeMap, Comparable<Channel>

Direct Known Subclasses:

NioDatagramChannel, NioSctpChannel, NioSctpServerChannel, NioServerDomainSocketChannel, NioServerSocketChannel, NioUdtAcceptorChannel, NioUdtMessageConnectorChannel

public abstract class AbstractNioMessageChannel
extends AbstractNioChannel

AbstractNioChannel base class for Channels that operate on messages.

Nested Class Summary

Nested classes/interfaces inherited from class AbstractNioChannel

AbstractNioChannel.AbstractNioUnsafe, AbstractNioChannel.NioUnsafe

Modifier and Type	Class	Description
protected class	AbstractNioChannel.AbstractNioUnsafe
static interface	AbstractNioChannel.NioUnsafe	Special Channel.Unsafe sub-type which allows to access the underlying SelectableChannel

Nested classes/interfaces inherited from class AbstractChannel

AbstractChannel.AbstractUnsafe

Modifier and Type	Class	Description
protected class	AbstractChannel.AbstractUnsafe	Channel.Unsafe implementation which sub-classes must extend and use.

Nested classes/interfaces inherited from interface Channel

Channel.Unsafe

Modifier and Type	Interface	Description
static interface	Channel.Unsafe	Unsafe operations that should never be called from user-code.

Field Summary

Fields inherited from class AbstractNioChannel

readInterestOp

Modifier and Type	Field	Description
protected final int	readInterestOp

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractNioMessageChannel(Channel parent, SelectableChannel ch, int readInterestOp)

Method Summary

Modifier and Type	Method	Description
protected boolean	closeOnReadError(Throwable cause)
protected boolean	continueOnWriteError()	Returns true if we should continue the write loop on a write error.
protected boolean	continueReading(RecvByteBufAllocator.Handle allocHandle)
protected void	doBeginRead()	Schedule a read operation.
protected abstract int	doReadMessages(List<Object> buf)	Read messages into the given array and return the amount which was read.
protected void	doWrite(ChannelOutboundBuffer in)	Flush the content of the given buffer to the remote peer.
protected abstract boolean	doWriteMessage(Object msg, ChannelOutboundBuffer in)	Write a message to the underlying Channel.
protected AbstractNioChannel.AbstractNioUnsafe	newUnsafe()	Create a new AbstractChannel.AbstractUnsafe instance which will be used for the life-time of the Channel

Methods inherited from class AbstractNioChannel

clearReadPending, doClose, doConnect, doDeregister, doFinishConnect, doRegister, eventLoop, isCompatible, isOpen, isReadPending, javaChannel, newDirectBuffer, newDirectBuffer, selectionKey, setReadPending, unsafe

Modifier and Type	Method	Description
protected final void	clearReadPending()	Set read pending to false.
protected void	doClose()	Close the Channel
protected abstract boolean	doConnect(SocketAddress remoteAddress, SocketAddress localAddress)	Connect to the remote peer
protected void	doDeregister()	Deregister the Channel from its EventLoop.
protected abstract void	doFinishConnect()	Finish the connect
protected void	doRegister()	Is called after the Channel is registered with its EventLoop as part of the register process.
NioEventLoop	eventLoop()	Return the EventLoop this Channel was registered to.
protected boolean	isCompatible(EventLoop loop)	Return true if the given EventLoop is compatible with this instance.
boolean	isOpen()	Returns true if the Channel is open and may get active later
protected boolean	isReadPending()	Deprecated. No longer supported.
protected SelectableChannel	javaChannel()
protected final ByteBuf	newDirectBuffer(ByteBuf buf)	Returns an off-heap copy of the specified ByteBuf, and releases the original one.
protected final ByteBuf	newDirectBuffer(ReferenceCounted holder, ByteBuf buf)	Returns an off-heap copy of the specified ByteBuf, and releases the specified holder.
protected SelectionKey	selectionKey()	Return the current SelectionKey
protected void	setReadPending(boolean readPending)	Deprecated. Use AbstractNioChannel.clearReadPending() if appropriate instead.
AbstractNioChannel.NioUnsafe	unsafe()	Returns an internal-use-only object that provides unsafe operations.

Methods inherited from class AbstractChannel

alloc, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, doBind, doDisconnect, doShutdownOutput, equals, filterOutboundMessage, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, localAddress, localAddress0, maxMessagesPerWrite, newChannelPipeline, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, remoteAddress, remoteAddress0, toString, validateFileRegion, voidPromise, write, write, writeAndFlush, writeAndFlush

Modifier and Type	Method	Description
ByteBufAllocator	alloc()	Return the assigned ByteBufAllocator which will be used to allocate ByteBufs.
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.
long	bytesBeforeUnwritable()	Get how many bytes can be written until Channel.isWritable() returns false.
long	bytesBeforeWritable()	Get how many bytes must be drained from underlying buffers until Channel.isWritable() returns true.
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	closeFuture()	Returns the ChannelFuture which will be notified when this channel is closed.
final int	compareTo(Channel o)
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.
protected abstract void	doBind(SocketAddress localAddress)	Bind the Channel to the SocketAddress
protected abstract void	doDisconnect()	Disconnect this Channel from its remote peer
protected void	doShutdownOutput()	Called when conditions justify shutting down the output portion of the channel.
final boolean	equals(Object o)	Returns true if and only if the specified object is identical with this channel (i.e: this == o).
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.
Channel	flush()	Request to flush all pending messages via this ChannelOutboundInvoker.
final int	hashCode()	Returns the ID of this channel.
final ChannelId	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.
boolean	isRegistered()	Returns true if the Channel is registered with an EventLoop.
boolean	isWritable()	Returns true if and only if the I/O thread will perform the requested write operation immediately.
SocketAddress	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.
ChannelFuture	newFailedFuture(Throwable cause)	Create a new ChannelFuture which is marked as failed already.
protected ChannelId	newId()	Returns a new DefaultChannelId instance.
ChannelProgressivePromise	newProgressivePromise()	Return an new ChannelProgressivePromise
ChannelPromise	newPromise()	Return a new ChannelPromise.
ChannelFuture	newSucceededFuture()	Create a new ChannelFuture which is marked as succeeded already.
Channel	parent()	Returns the parent of this channel.
ChannelPipeline	pipeline()	Return the assigned ChannelPipeline.
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.
SocketAddress	remoteAddress()	Returns the remote address where this channel is connected to.
protected abstract SocketAddress	remoteAddress0()	Return the SocketAddress which the Channel is connected to.
String	toString()	Returns the String representation of this channel.
protected void	validateFileRegion(DefaultFileRegion region, long position)
final 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 DefaultAttributeMap

attr, hasAttr

Modifier and Type	Method	Description
<T> Attribute<T>	attr(AttributeKey<T> key)	Get the Attribute for the given AttributeKey.
<T> boolean	hasAttr(AttributeKey<T> key)	Returns true if and only if the given Attribute exists in this AttributeMap.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Channel

config, isActive, metadata

Modifier and Type	Method	Description
ChannelConfig	config()	Returns the configuration of this channel.
boolean	isActive()	Return true if the Channel is active and so connected.
ChannelMetadata	metadata()	Return the ChannelMetadata of the Channel which describe the nature of the Channel.

Constructor Details

AbstractNioMessageChannel

protected AbstractNioMessageChannel(Channel parent,
 SelectableChannel ch,
 int readInterestOp)

See Also:

• AbstractNioChannel(Channel, SelectableChannel, int)

Method Details

newUnsafe

protected AbstractNioChannel.AbstractNioUnsafe newUnsafe()

Description copied from class: AbstractChannel

Create a new AbstractChannel.AbstractUnsafe instance which will be used for the life-time of the Channel

Specified by:

newUnsafe in class AbstractChannel

doBeginRead

protected void doBeginRead()
                    throws Exception

Description copied from class: AbstractChannel

Schedule a read operation.

Overrides:

doBeginRead in class AbstractNioChannel

Throws:

Exception

continueReading

protected boolean continueReading(RecvByteBufAllocator.Handle allocHandle)

doWrite

protected void doWrite(ChannelOutboundBuffer in)
                throws Exception

Description copied from class: AbstractChannel

Flush the content of the given buffer to the remote peer.

Specified by:

doWrite in class AbstractChannel

Throws:

Exception

continueOnWriteError

protected boolean continueOnWriteError()

Returns true if we should continue the write loop on a write error.

closeOnReadError

protected boolean closeOnReadError(Throwable cause)

doReadMessages

protected abstract int doReadMessages(List<Object> buf)
                               throws Exception

Read messages into the given array and return the amount which was read.

Throws:

Exception

doWriteMessage

protected abstract boolean doWriteMessage(Object msg,
 ChannelOutboundBuffer in)
                                   throws Exception

Write a message to the underlying Channel.

Returns:

true if and only if the message has been written

Throws:

Exception