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

Direct Known Subclasses:

NioSocketChannel

public abstract class AbstractNioByteChannel
extends AbstractNioChannel

AbstractNioChannel base class for Channels that operate on bytes.

Nested Class Summary

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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract int	doReadBytes(io.netty.buffer.ByteBuf buf) Read bytes into the given ByteBuf and return the amount.
protected int	doWrite(MessageList<Object> msgs, int index) Flush the content of the given ByteBuf to the remote peer.
protected abstract int	doWriteBytes(io.netty.buffer.ByteBuf buf, boolean lastSpin) Write bytes form the given ByteBuf to the underlying Channel.
protected abstract long	doWriteFileRegion(FileRegion region, boolean lastSpin) Write a FileRegion
protected AbstractNioChannel.AbstractNioUnsafe	newUnsafe() Create a new AbstractChannel.AbstractUnsafe instance which will be used for the life-time of the Channel
protected void	updateOpWrite(long expectedWrittenBytes, long writtenBytes, boolean lastSpin)

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

doBeginRead, doConnect, doDeregister, doFinishConnect, doRegister, eventLoop, isCompatible, isFlushPending, isInputShutdown, isOpen, javaChannel, selectionKey, unsafe

Methods inherited from class io.netty.channel.AbstractChannel

alloc, bind, bind, calculateMessageSize, checkEOF, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, doBind, doClose, doDisconnect, doPreClose, equals, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, localAddress, localAddress0, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, remoteAddress, remoteAddress0, toString, voidPromise, write, write, write, write

Methods inherited from class io.netty.util.DefaultAttributeMap

attr

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.Channel

config, isActive, metadata

Methods inherited from interface io.netty.util.AttributeMap

attr

Constructor Detail

AbstractNioByteChannel

protected AbstractNioByteChannel(Channel parent,
                      Integer id,
                      SelectableChannel ch)

Create a new instance

Parameters:

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

id - the id of this instance or null if one should be generated

ch - the underlying SelectableChannel on which it operates

Method Detail

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

doWrite

protected int doWrite(MessageList<Object> msgs,
          int index)
               throws Exception

Description copied from class: AbstractChannel

Flush the content of the given ByteBuf to the remote peer. Sub-classes may override this as this implementation will just thrown an UnsupportedOperationException

Specified by:

doWrite in class AbstractChannel

Returns:

the number of written messages

Throws:

Exception

doWriteFileRegion

protected abstract long doWriteFileRegion(FileRegion region,
                     boolean lastSpin)
                                   throws Exception

Write a FileRegion

Parameters:

region - the FileRegion from which the bytes should be written

lastSpin - true if this is the last write try

Returns:

amount the amount of written bytes

Throws:

Exception - thrown if an error accour

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,
               boolean lastSpin)
                             throws Exception

Write bytes form the given ByteBuf to the underlying Channel.

Parameters:

buf - the ByteBuf from which the bytes should be written

lastSpin - true if this is the last write try

Returns:

amount the amount of written bytes

Throws:

Exception - thrown if an error accour

updateOpWrite

protected final void updateOpWrite(long expectedWrittenBytes,
                 long writtenBytes,
                 boolean lastSpin)