Class AbstractNioByteChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.nio.AbstractNioChannel

io.netty.channel.nio.AbstractNioByteChannel

All Implemented Interfaces:

Channel, ChannelOutboundInvoker, AttributeMap, Comparable<Channel>

Direct Known Subclasses:

NioDomainSocketChannel, NioSocketChannel, NioUdtByteConnectorChannel

public abstract class AbstractNioByteChannel
extends AbstractNioChannel

AbstractNioChannel base class for Channels that operate on bytes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractNioByteChannel.NioByteUnsafe

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, readOps

Modifier and Type	Field	Description
protected final int	readInterestOp
protected final NioIoOps	readOps

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractNioByteChannel(Channel parent, SelectableChannel ch)	Create a new instance

Method Summary

Modifier and Type	Method	Description
protected final void	clearOpWrite()
protected abstract int	doReadBytes(ByteBuf buf)	Read bytes into the given ByteBuf and return the amount.
protected void	doWrite(ChannelOutboundBuffer in)	Flush the content of the given buffer to the remote peer.
protected final int	doWrite0(ChannelOutboundBuffer in)	Write objects to the OS.
protected abstract int	doWriteBytes(ByteBuf buf)	Write bytes form the given ByteBuf to the underlying Channel.
protected abstract long	doWriteFileRegion(FileRegion region)	Write a FileRegion
protected final 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.
protected final void	incompleteWrite(boolean setOpWrite)
protected boolean	isInputShutdown0()
ChannelMetadata	metadata()	Return the ChannelMetadata of the Channel which describe the nature of the Channel.
protected AbstractNioChannel.AbstractNioUnsafe	newUnsafe()	Create a new AbstractChannel.AbstractUnsafe instance which will be used for the life-time of the Channel
protected final void	setOpWrite()
protected abstract ChannelFuture	shutdownInput()	Shutdown the input side of the channel.

Methods inherited from class AbstractNioChannel

addAndSubmit, clearReadPending, doBeginRead, doClose, doConnect, doDeregister, doFinishConnect, doRegister, isCompatible, isOpen, isReadPending, javaChannel, newDirectBuffer, newDirectBuffer, registration, removeAndSubmit, selectionKey, setReadPending, unsafe

Modifier and Type	Method	Description
protected void	addAndSubmit(NioIoOps addOps)
protected final void	clearReadPending()	Set read pending to false.
protected void	doBeginRead()	Schedule a read operation.
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(ChannelPromise promise)	Is called after the Channel is registered with its EventLoop as part of the register process.
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 IoRegistration	registration()
protected void	removeAndSubmit(NioIoOps removeOps)
protected SelectionKey	selectionKey()	Deprecated. use AbstractNioChannel.registration.
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

closeFuture, compareTo, doBind, doDisconnect, doRegister, doShutdownOutput, equals, eventLoop, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, localAddress, localAddress0, maxMessagesPerWrite, newChannelPipeline, newId, parent, pipeline, remoteAddress, remoteAddress0, toString, validateFileRegion, voidPromise

Modifier and Type	Method	Description
ChannelFuture	closeFuture()	Returns the ChannelFuture which will be notified when this channel is closed.
final int	compareTo(Channel o)
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	doRegister()	Deprecated. use AbstractChannel.doRegister(ChannelPromise)
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).
EventLoop	eventLoop()	Return the EventLoop this Channel was registered to.
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.
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.
protected ChannelId	newId()	Returns a new DefaultChannelId instance.
Channel	parent()	Returns the parent of this channel.
ChannelPipeline	pipeline()	Return the assigned ChannelPipeline.
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.

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

alloc, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, config, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, flush, getOption, isActive, isWritable, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, read, setOption, write, write, writeAndFlush, writeAndFlush

Modifier and Type	Method	Description
default ByteBufAllocator	alloc()	Return the assigned ByteBufAllocator which will be used to allocate ByteBufs.
default 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.
default 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.
default long	bytesBeforeUnwritable()	Get how many bytes can be written until Channel.isWritable() returns false.
default long	bytesBeforeWritable()	Get how many bytes must be drained from underlying buffers until Channel.isWritable() returns true.
default 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.
default 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.
ChannelConfig	config()	Returns the configuration of this channel.
default 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.
default 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.
default 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.
default 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.
default 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.
default 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.
default 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.
default 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.
default Channel	flush()	Request to flush all pending messages via this ChannelOutboundInvoker.
default <T> T	getOption(ChannelOption<T> option)	Return the value of the given ChannelOption
boolean	isActive()	Return true if the Channel is active and so connected.
default boolean	isWritable()	Returns true if and only if the I/O thread will perform the requested write operation immediately.
default ChannelFuture	newFailedFuture(Throwable cause)	Create a new ChannelFuture which is marked as failed already.
default ChannelProgressivePromise	newProgressivePromise()	Return an new ChannelProgressivePromise
default ChannelPromise	newPromise()	Return a new ChannelPromise.
default ChannelFuture	newSucceededFuture()	Create a new ChannelFuture which is marked as succeeded already.
default 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.
default <T> boolean	setOption(ChannelOption<T> option, T value)	Sets a configuration property with the specified name and value.
default ChannelFuture	write(Object msg)	Request to write a message via this ChannelHandlerContext through the ChannelPipeline.
default ChannelFuture	write(Object msg, ChannelPromise promise)	Request to write a message via this ChannelHandlerContext through the ChannelPipeline.
default ChannelFuture	writeAndFlush(Object msg)	Shortcut for call ChannelOutboundInvoker.write(Object) and ChannelOutboundInvoker.flush().
default ChannelFuture	writeAndFlush(Object msg, ChannelPromise promise)	Shortcut for call ChannelOutboundInvoker.write(Object, ChannelPromise) and ChannelOutboundInvoker.flush().

Constructor Details

AbstractNioByteChannel

protected AbstractNioByteChannel(Channel parent,
 SelectableChannel ch)

Create a new instance

Parameters:

parent - the parent Channel by which this instance was created. May be null

ch - the underlying SelectableChannel on which it operates

Method Details

shutdownInput

protected abstract ChannelFuture shutdownInput()

Shutdown the input side of the channel.

isInputShutdown0

protected boolean isInputShutdown0()

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

metadata

public ChannelMetadata metadata()

Description copied from interface: Channel

Return the ChannelMetadata of the Channel which describe the nature of the Channel.

doWrite0

protected final int doWrite0(ChannelOutboundBuffer in)
                      throws Exception

Write objects to the OS.

Parameters:

in - the collection which contains objects to write.

Returns:

The value that should be decremented from the write quantum which starts at ChannelConfig.getWriteSpinCount(). The typical use cases are as follows:

• 0 - if no write was attempted. This is appropriate if an empty ByteBuf (or other empty content) is encountered
• 1 - if a single call to write data was made to the OS
• ChannelUtils.WRITE_STATUS_SNDBUF_FULL - if an attempt to write data was made to the OS, but no data was accepted

Throws:

Exception - if an I/O exception occurs during write.

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

filterOutboundMessage

protected final Object filterOutboundMessage(Object msg)

Description copied from class: AbstractChannel

Invoked when a new message is added to a ChannelOutboundBuffer of this AbstractChannel, so that the Channel implementation converts the message to another. (e.g. heap buffer -> direct buffer)

Overrides:

filterOutboundMessage in class AbstractChannel

incompleteWrite

protected final void incompleteWrite(boolean setOpWrite)

doWriteFileRegion

protected abstract long doWriteFileRegion(FileRegion region)
                                   throws Exception

Write a FileRegion

Parameters:

region - the FileRegion from which the bytes should be written

Returns:

amount the amount of written bytes

Throws:

Exception

doReadBytes

protected abstract int doReadBytes(ByteBuf buf)
                            throws Exception

Read bytes into the given ByteBuf and return the amount.

Throws:

Exception

doWriteBytes

protected abstract int doWriteBytes(ByteBuf buf)
                             throws Exception

Write bytes form the given ByteBuf to the underlying Channel.

Parameters:

buf - the ByteBuf from which the bytes should be written

Returns:

amount the amount of written bytes

Throws:

Exception

setOpWrite

protected final void setOpWrite()

clearOpWrite

protected final void clearOpWrite()