Class AbstractNioMessageChannel

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

Nested classes/interfaces inherited from class AbstractChannel
AbstractChannel.AbstractUnsafe

Nested classes/interfaces inherited from interface Channel
Channel.Unsafe
Field Summary

Fields inherited from class AbstractNioChannel
readInterestOp, readOps
Constructor Summary

Constructors

Modifier

Constructor

Description

protected

AbstractNioMessageChannel (Channel parent, SelectableChannel ch, int readInterestOp)

protected

AbstractNioMessageChannel (Channel parent, SelectableChannel ch, NioIoOps readOps)
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
addAndSubmit, clearReadPending, doClose, doConnect, doDeregister, doFinishConnect, doRegister, isCompatible, isOpen, isReadPending, javaChannel, newDirectBuffer, newDirectBuffer, registration, removeAndSubmit, selectionKey, setReadPending, unsafe

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

Methods inherited from class DefaultAttributeMap
attr, hasAttr

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface AttributeMap
attr, hasAttr

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, metadata, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, read, setOption, write, write, writeAndFlush, writeAndFlush

Constructor Details
- AbstractNioMessageChannel
  protected AbstractNioMessageChannel(Channel parent, SelectableChannel ch, int readInterestOp)
  
  See Also:
  
  AbstractNioChannel(Channel, SelectableChannel, int)
- AbstractNioMessageChannel
  
  protected AbstractNioMessageChannel(Channel parent, SelectableChannel ch, NioIoOps readOps)
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

Class AbstractNioMessageChannel

Nested Class Summary

Nested classes/interfaces inherited from class AbstractNioChannel

Nested classes/interfaces inherited from class AbstractChannel

Nested classes/interfaces inherited from interface Channel

Field Summary

Fields inherited from class AbstractNioChannel

Constructor Summary

Method Summary

Methods inherited from class AbstractNioChannel

Methods inherited from class AbstractChannel

Methods inherited from class DefaultAttributeMap

Methods inherited from class Object

Methods inherited from interface AttributeMap

Methods inherited from interface Channel

Constructor Details

AbstractNioMessageChannel

AbstractNioMessageChannel

Method Details

newUnsafe

doBeginRead

continueReading

doWrite

continueOnWriteError

closeOnReadError

doReadMessages

doWriteMessage