Package io.netty.channel.nio

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, io.netty.util.AttributeMap, Comparable<Channel>

Direct Known Subclasses:

NioDomainSocketChannel, NioSocketChannel

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 io.netty.channel.nio.AbstractNioChannel

AbstractNioChannel.AbstractNioUnsafe, AbstractNioChannel.NioUnsafe

Nested classes/interfaces inherited from class io.netty.channel.AbstractChannel

AbstractChannel.AbstractUnsafe

Nested classes/interfaces inherited from interface io.netty.channel.Channel

Channel.Unsafe

Field Summary

Fields inherited from class io.netty.channel.nio.AbstractNioChannel

readInterestOp, 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 void	clearOpWrite()
protected abstract int	doReadBytes(io.netty.buffer.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 int	doWrite0(ChannelOutboundBuffer in)	Write objects to the OS.
protected abstract int	doWriteBytes(io.netty.buffer.ByteBuf buf)	Write bytes form the given ByteBuf to the underlying Channel.
protected abstract long	doWriteFileRegion(FileRegion region)	Write a FileRegion
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.
protected 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 void	setOpWrite()
protected abstract ChannelFuture	shutdownInput()	Shutdown the input side of the channel.

Methods inherited from class io.netty.channel.nio.AbstractNioChannel

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

Methods inherited from class io.netty.channel.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

Methods inherited from class io.netty.util.DefaultAttributeMap

attr, hasAttr

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.util.AttributeMap

attr, hasAttr

Methods inherited from interface io.netty.channel.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

Constructor Detail

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 Detail

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(io.netty.buffer.ByteBuf buf)
                            throws Exception

Read bytes into the given ByteBuf and return the amount.

Throws:

Exception

doWriteBytes

protected abstract int doWriteBytes(io.netty.buffer.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()