io.netty.channel.udt.nio

Class NioUdtByteAcceptorChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.nio.AbstractNioChannel

io.netty.channel.nio.AbstractNioMessageChannel

io.netty.channel.udt.nio.NioUdtAcceptorChannel

io.netty.channel.udt.nio.NioUdtByteAcceptorChannel

All Implemented Interfaces:

Channel, ServerChannel, UdtChannel, UdtServerChannel, AttributeMap, Comparable<Channel>

public class NioUdtByteAcceptorChannel
extends NioUdtAcceptorChannel

Byte Channel Acceptor for UDT Streams.

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.udt.nio.NioUdtAcceptorChannel

logger

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

readInterestOp

Fields inherited from class io.netty.channel.AbstractChannel

flushFutureNotifier

Constructor Summary

Constructors

Constructor and Description
NioUdtByteAcceptorChannel()

Method Summary

Methods

Modifier and Type	Method and Description
ByteBufAllocator	alloc() Return the assigned ByteBufAllocator which will be used for 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.
ChannelFuture	close() Request to close this ChannelOutboundInvoker 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 this ChannelOutboundInvoker and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
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 this ChannelOutboundInvoker 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 this ChannelOutboundInvoker 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 discconect 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 discconect from the remote peer and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
protected int	doReadMessages(MessageBuf<Object> buf) Read messages into the given MessageBuf and return the amount.
ChannelFuture	flush() Request to flush all pending data which belongs to this ChannelOutboundInvoker and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	flush(ChannelPromise promise) Request to flush all pending data which belongs to this ChannelOutboundInvoker and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelMetadata	metadata() Return the ChannelMetadata of the Channel which describe the nature of the Channel.
ChannelFuture	newFailedFuture(Throwable cause) Create a new Future which is marked as fakued already.
ChannelPromise	newPromise() Return a new Promise.
ChannelFuture	newSucceededFuture() Create a new Future which is marked as successes already.
ChannelPipeline	pipeline() Return the assigned ChannelPipeline
void	read() Request to Read data from the Channel into the first inbound buffer, triggers an inboundBufferUpdated event if data was read, and triggers an channelReadSuspended event so the handler can decide to continue reading.
ChannelFuture	sendFile(FileRegion region) Request to send a FileRegion via this ChannelOutboundInvoker and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	sendFile(FileRegion region, ChannelPromise promise) Request to send a FileRegion via this ChannelOutboundInvoker and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	write(Object message) Request to write a message via this ChannelOutboundInvoker and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
ChannelFuture	write(Object message, ChannelPromise promise) Request to write a message via this ChannelOutboundInvoker and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.

Methods inherited from class io.netty.channel.udt.nio.NioUdtAcceptorChannel

config, doBind, doClose, doConnect, doDisconnect, doFinishConnect, doWriteMessages, isActive, javaChannel, localAddress, localAddress0, remoteAddress, remoteAddress0

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

doFlushMessageBuffer, newUnsafe

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

doBeginRead, doDeregister, doRegister, eventLoop, isCompatible, isFlushPending, isInputShutdown, isOpen, selectionKey, unsafe

Methods inherited from class io.netty.channel.AbstractChannel

alloc, bind, bind, checkEOF, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, doFlushByteBuffer, doFlushFileRegion, doPreClose, equals, expandReadBuffer, flush, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, newFailedFuture, newPromise, newSucceededFuture, outboundByteBuffer, outboundMessageBuffer, parent, pipeline, read, sendFile, sendFile, toString, 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

closeFuture, eventLoop, id, isOpen, isRegistered, outboundByteBuffer, outboundMessageBuffer, parent, unsafe

Methods inherited from interface io.netty.util.AttributeMap

attr

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

NioUdtByteAcceptorChannel

public NioUdtByteAcceptorChannel()

Method Detail

doReadMessages

protected int doReadMessages(MessageBuf<Object> buf)
                      throws Exception

Description copied from class: AbstractNioMessageChannel

Read messages into the given MessageBuf and return the amount.

Specified by:

doReadMessages in class AbstractNioMessageChannel

Throws:

Exception

metadata

public ChannelMetadata metadata()

Description copied from interface: Channel

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

bind

public 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.

This will result in having the ChannelOperationHandler.bind(ChannelHandlerContext, SocketAddress, ChannelPromise) method called of the next ChannelOperationHandler contained in the ChannelPipeline of the Channel.

connect

public 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.

If the connection fails because of a connection timeout, the ChannelFuture will get failed with a ConnectTimeoutException. If it fails because of connection refused a ConnectException will be used.

This will result in having the ChannelOperationHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) method called of the next ChannelOperationHandler contained in the ChannelPipeline of the Channel.

connect

public 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.

This will result in having the ChannelOperationHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) method called of the next ChannelOperationHandler contained in the ChannelPipeline of the Channel.

disconnect

public ChannelFuture disconnect()

Request to discconect from the remote peer and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.

This will result in having the ChannelOperationHandler.disconnect(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOperationHandler contained in the ChannelPipeline of the Channel.

close

public ChannelFuture close()

Request to close this ChannelOutboundInvoker and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. After it is closed it is not possible to reuse it again.

This will result in having the ChannelOperationHandler.close(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOperationHandler contained in the ChannelPipeline of the Channel.

deregister

public ChannelFuture deregister()

Request to deregister this ChannelOutboundInvoker from the previous assigned EventExecutor and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.

This will result in having the ChannelOperationHandler.deregister(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOperationHandler contained in the ChannelPipeline of the Channel.

flush

public ChannelFuture flush()

Request to flush all pending data which belongs to this ChannelOutboundInvoker and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.

Be aware that the flush could be only partially successful. In such cases the ChannelFuture will be failed with an IncompleteFlushException. So if you are interested to know if it was partial successful you need to check if the returned Future.cause() returns an instance of IncompleteFlushException. In such cases you may want to call flush(ChannelPromise) or flush() to flush the rest of the data or just close the connection via close(ChannelPromise) or close() if it is not possible to recover.

This will result in having the ChannelOperationHandler.flush(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOperationHandler contained in the ChannelPipeline of the Channel.

write

public ChannelFuture write(Object message)

Request to write a message via this ChannelOutboundInvoker and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. If you want to write a FileRegion use sendFile(FileRegion).

Be aware that the write could be only partially successful as the message may need to get encoded before write it to the remote peer. In such cases the ChannelFuture will be failed with a IncompleteFlushException. In such cases you may want to call flush(ChannelPromise) or flush() to flush the rest of the data or just close the connection via close(ChannelPromise) or close() if it is not possible to recover.

This will result in having the message added to the outbound buffer of the next ChannelOutboundHandler and the ChannelOperationHandler.flush(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOperationHandler contained in the ChannelPipeline of the Channel.

sendFile

public ChannelFuture sendFile(FileRegion region)

Request to send a FileRegion via this ChannelOutboundInvoker and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.

This will result in having the ChannelOperationHandler.sendFile(ChannelHandlerContext, FileRegion, ChannelPromise) method called of the next ChannelOperationHandler contained in the ChannelPipeline of the Channel.

bind

public 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. The given ChannelPromise will be notified.

This will result in having the ChannelOperationHandler.bind(ChannelHandlerContext, SocketAddress, ChannelPromise) method called of the next ChannelOperationHandler contained in the ChannelPipeline of the Channel.

connect

public 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. The given ChannelFuture will be notified.

If the connection fails because of a connection timeout, the ChannelFuture will get failed with a ConnectTimeoutException. If it fails because of connection refused a ConnectException will be used.

This will result in having the ChannelOperationHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) method called of the next ChannelOperationHandler contained in the ChannelPipeline of the Channel.

connect

public 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. The given ChannelPromise will be notified and also returned.

This will result in having the ChannelOperationHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) method called of the next ChannelOperationHandler contained in the ChannelPipeline of the Channel.

disconnect

public ChannelFuture disconnect(ChannelPromise promise)

Request to discconect from the remote peer and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. The given ChannelPromise will be notified.

This will result in having the ChannelOperationHandler.disconnect(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOperationHandler contained in the ChannelPipeline of the Channel.

close

public ChannelFuture close(ChannelPromise promise)

Request to close this ChannelOutboundInvoker and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. After it is closed it is not possible to reuse it again. The given ChannelPromise will be notified.

This will result in having the ChannelOperationHandler.close(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOperationHandler contained in the ChannelPipeline of the Channel.

deregister

public ChannelFuture deregister(ChannelPromise promise)

Request to deregister this ChannelOutboundInvoker from the previous assigned EventExecutor and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. The given ChannelPromise will be notified.

This will result in having the ChannelOperationHandler.deregister(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOperationHandler contained in the ChannelPipeline of the Channel.

read

public void read()

Request to Read data from the Channel into the first inbound buffer, triggers an inboundBufferUpdated event if data was read, and triggers an channelReadSuspended event so the handler can decide to continue reading. If there's a pending read operation already, this method does nothing.

This will result in having the ChannelOperationHandler.read(ChannelHandlerContext) method called of the next ChannelOperationHandler contained in the ChannelPipeline of the Channel.

flush

public ChannelFuture flush(ChannelPromise promise)

Request to flush all pending data which belongs to this ChannelOutboundInvoker and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.

Be aware that the flush could be only partially successful. In such cases the ChannelFuture will be failed with an IncompleteFlushException. So if you are interested to know if it was partial successful you need to check if the returned Future.cause() returns an instance of IncompleteFlushException. In such cases you may want to call flush(ChannelPromise) or flush() to flush the rest of the data or just close the connection via close(ChannelPromise) or close() if it is not possible to recover. The given ChannelPromise will be notified.

This will result in having the ChannelOperationHandler.flush(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOperationHandler contained in the ChannelPipeline of the Channel.

write

public ChannelFuture write(Object message,
                  ChannelPromise promise)

Request to write a message via this ChannelOutboundInvoker and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. If you want to write a FileRegion use sendFile(FileRegion).

Be aware that the write could be only partially successful as the message may need to get encoded before write it to the remote peer. In such cases the ChannelFuture will be failed with a IncompleteFlushException. In such cases you may want to call flush(ChannelPromise) or flush() to flush the rest of the data or just close the connection via close(ChannelPromise) or close() if it is not possible to recover. The given ChannelPromise will be notified.

This will result in having the message added to the outbound buffer of the next ChannelOutboundHandler and the ChannelOperationHandler.flush(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOperationHandler contained in the ChannelPipeline of the Channel.

sendFile

public ChannelFuture sendFile(FileRegion region,
                     ChannelPromise promise)

Request to send a FileRegion via this ChannelOutboundInvoker and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. The given ChannelPromise will be notified.

This will result in having the ChannelOperationHandler.sendFile(ChannelHandlerContext, FileRegion, ChannelPromise) method called of the next ChannelOperationHandler contained in the ChannelPipeline of the Channel.

pipeline

public ChannelPipeline pipeline()

Return the assigned ChannelPipeline

alloc

public ByteBufAllocator alloc()

Return the assigned ByteBufAllocator which will be used for allocate ByteBufs.

newPromise

public ChannelPromise newPromise()

Description copied from interface: FutureFactory

Return a new Promise.

Specified by:

newPromise in interface FutureFactory

newSucceededFuture

public ChannelFuture newSucceededFuture()

Description copied from interface: FutureFactory

Create a new Future which is marked as successes already. So Future.isSuccess() will return true. All FutureListener added to it will be notified directly. Also every call of blocking methods will just return without blocking.

Specified by:

newSucceededFuture in interface FutureFactory

newFailedFuture

public ChannelFuture newFailedFuture(Throwable cause)

Description copied from interface: FutureFactory

Create a new Future which is marked as fakued already. So Future.isSuccess() will return false. All FutureListener added to it will be notified directly. Also every call of blocking methods will just return without blocking.

Specified by:

newFailedFuture in interface FutureFactory