io.netty.channel.socket.nio

Class NioSocketChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.nio.AbstractNioChannel

io.netty.channel.nio.AbstractNioByteChannel

io.netty.channel.socket.nio.NioSocketChannel

All Implemented Interfaces:

Channel, SocketChannel, io.netty.util.AttributeMap, Comparable<Channel>

public class NioSocketChannel
extends AbstractNioByteChannel
implements SocketChannel

SocketChannel which uses NIO selector based implementation.

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

Constructor and Description
NioSocketChannel() Create a new instance
NioSocketChannel(Channel parent, Integer id, SocketChannel socket) Create a new instance
NioSocketChannel(SocketChannel socket) Create a new instance using the given SocketChannel.

Method Summary

Methods

Modifier and Type	Method and Description
io.netty.buffer.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.
SocketChannelConfig	config() Returns the configuration of this channel.
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 void	doBind(SocketAddress localAddress) Bind the Channel to the SocketAddress
protected void	doClose() Close the Channel
protected boolean	doConnect(SocketAddress remoteAddress, SocketAddress localAddress) Connect to the remote peer
protected void	doDisconnect() Disconnect this Channel from its remote peer
protected void	doFinishConnect() Finish the connect
protected int	doReadBytes(io.netty.buffer.ByteBuf byteBuf) 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 int	doWriteBytes(io.netty.buffer.ByteBuf buf, boolean lastSpin) Write bytes form the given ByteBuf to the underlying Channel.
protected long	doWriteFileRegion(FileRegion region, boolean lastSpin) Write a FileRegion
boolean	isActive() Return true if the Channel is active and so connected.
boolean	isInputShutdown() Return true if the input of this Channel is shutdown
boolean	isOutputShutdown()
protected SocketChannel	javaChannel()
InetSocketAddress	localAddress() Returns the local address where this channel is bound to.
protected SocketAddress	localAddress0() Returns the SocketAddress which is bound locally.
ChannelMetadata	metadata() Return the ChannelMetadata of the Channel which describe the nature of the Channel.
ChannelFuture	newFailedFuture(Throwable cause) Create a new ChannelFuture which is marked as fakued already.
ChannelProgressivePromise	newProgressivePromise() Return an new ChannelProgressivePromise
ChannelPromise	newPromise() Return a new ChannelPromise.
ChannelFuture	newSucceededFuture() Create a new ChannelFuture which is marked as successes already.
ServerSocketChannel	parent() Returns the parent of this channel.
ChannelPipeline	pipeline() Return the assigned ChannelPipeline
void	read() Request to Read data from the Channel into the first inbound buffer, triggers an ChannelInboundHandler.messageReceived(ChannelHandlerContext, MessageList) event if data was read, and triggers an channelReadSuspended event so the handler can decide to continue reading.
InetSocketAddress	remoteAddress() Returns the remote address where this channel is connected to.
protected SocketAddress	remoteAddress0() Return the SocketAddress which the Channel is connected to.
ChannelFuture	shutdownOutput()
ChannelFuture	shutdownOutput(ChannelPromise promise)
ChannelPromise	voidPromise() Return a special ChannelPromise which can be reused for different operations.
ChannelFuture	write(MessageList<?> msgs)
ChannelFuture	write(MessageList<?> msgs, ChannelPromise promise)
ChannelFuture	write(Object msg) 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 msg, 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.nio.AbstractNioByteChannel

newUnsafe, updateOpWrite

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

doBeginRead, doDeregister, doRegister, eventLoop, isCompatible, isFlushPending, isOpen, 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, doPreClose, equals, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, pipeline, read, 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

closeFuture, eventLoop, id, isOpen, isRegistered, isWritable, unsafe

Methods inherited from interface io.netty.util.AttributeMap

attr

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

NioSocketChannel

public NioSocketChannel()

Create a new instance

NioSocketChannel

public NioSocketChannel(SocketChannel socket)

Create a new instance using the given SocketChannel.

NioSocketChannel

public NioSocketChannel(Channel parent,
                Integer id,
                SocketChannel socket)

Create a new instance

Parameters:

parent - the Channel which created this instance or null if it was created by the user

id - the id to use for this instance or null if a new one should be generated

socket - the SocketChannel which will be used

Method Detail

parent

public ServerSocketChannel parent()

Description copied from interface: Channel

Returns the parent of this channel.

Specified by:

parent in interface Channel

Specified by:

parent in interface SocketChannel

Overrides:

parent in class AbstractChannel

Returns:

the parent channel. null if this channel does not have a parent channel.

metadata

public ChannelMetadata metadata()

Description copied from interface: Channel

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

Specified by:

metadata in interface Channel

config

public SocketChannelConfig config()

Description copied from interface: Channel

Returns the configuration of this channel.

Specified by:

config in interface Channel

Specified by:

config in interface SocketChannel

javaChannel

protected SocketChannel javaChannel()

Overrides:

javaChannel in class AbstractNioChannel

isActive

public boolean isActive()

Description copied from interface: Channel

Return true if the Channel is active and so connected.

Specified by:

isActive in interface Channel

isInputShutdown

public boolean isInputShutdown()

Description copied from class: AbstractNioChannel

Return true if the input of this Channel is shutdown

Specified by:

isInputShutdown in interface SocketChannel

Overrides:

isInputShutdown in class AbstractNioChannel

localAddress

public InetSocketAddress localAddress()

Description copied from interface: Channel

Returns the local address where this channel is bound to. The returned SocketAddress is supposed to be down-cast into more concrete type such as InetSocketAddress to retrieve the detailed information.

Specified by:

localAddress in interface Channel

Specified by:

localAddress in interface SocketChannel

Overrides:

localAddress in class AbstractChannel

Returns:

the local address of this channel. null if this channel is not bound.

remoteAddress

public InetSocketAddress remoteAddress()

Description copied from interface: Channel

Returns the remote address where this channel is connected to. The returned SocketAddress is supposed to be down-cast into more concrete type such as InetSocketAddress to retrieve the detailed information.

Specified by:

remoteAddress in interface Channel

Specified by:

remoteAddress in interface SocketChannel

Overrides:

remoteAddress in class AbstractChannel

Returns:

the remote address of this channel. null if this channel is not connected. If this channel is not connected but it can receive messages from arbitrary remote addresses (e.g. DatagramChannel, use DefaultAddressedEnvelope.recipient() to determine the origination of the received message as this method will return null.

isOutputShutdown

public boolean isOutputShutdown()

Specified by:

isOutputShutdown in interface SocketChannel

See Also:

Socket.isOutputShutdown()

shutdownOutput

public ChannelFuture shutdownOutput()

Specified by:

shutdownOutput in interface SocketChannel

See Also:

Socket.shutdownOutput()

shutdownOutput

public ChannelFuture shutdownOutput(ChannelPromise promise)

Specified by:

shutdownOutput in interface SocketChannel

See Also:

Will notify the given {@link ChannelPromise}

localAddress0

protected SocketAddress localAddress0()

Description copied from class: AbstractChannel

Returns the SocketAddress which is bound locally.

Specified by:

localAddress0 in class AbstractChannel

remoteAddress0

protected SocketAddress remoteAddress0()

Description copied from class: AbstractChannel

Return the SocketAddress which the Channel is connected to.

Specified by:

remoteAddress0 in class AbstractChannel

doBind

protected void doBind(SocketAddress localAddress)
               throws Exception

Description copied from class: AbstractChannel

Bind the Channel to the SocketAddress

Specified by:

doBind in class AbstractChannel

Throws:

Exception

doConnect

protected boolean doConnect(SocketAddress remoteAddress,
                SocketAddress localAddress)
                     throws Exception

Description copied from class: AbstractNioChannel

Connect to the remote peer

Specified by:

doConnect in class AbstractNioChannel

Throws:

Exception

doFinishConnect

protected void doFinishConnect()
                        throws Exception

Description copied from class: AbstractNioChannel

Finish the connect

Specified by:

doFinishConnect in class AbstractNioChannel

Throws:

Exception

doDisconnect

protected void doDisconnect()
                     throws Exception

Description copied from class: AbstractChannel

Disconnect this Channel from its remote peer

Specified by:

doDisconnect in class AbstractChannel

Throws:

Exception

doClose

protected void doClose()
                throws Exception

Description copied from class: AbstractChannel

Close the Channel

Specified by:

doClose in class AbstractChannel

Throws:

Exception

doReadBytes

protected int doReadBytes(io.netty.buffer.ByteBuf byteBuf)
                   throws Exception

Description copied from class: AbstractNioByteChannel

Read bytes into the given ByteBuf and return the amount.

Specified by:

doReadBytes in class AbstractNioByteChannel

Throws:

Exception

doWriteBytes

protected int doWriteBytes(io.netty.buffer.ByteBuf buf,
               boolean lastSpin)
                    throws Exception

Description copied from class: AbstractNioByteChannel

Write bytes form the given ByteBuf to the underlying Channel.

Specified by:

doWriteBytes in class AbstractNioByteChannel

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

doWriteFileRegion

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

Description copied from class: AbstractNioByteChannel

Write a FileRegion

Specified by:

doWriteFileRegion in class AbstractNioByteChannel

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

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

Overrides:

doWrite in class AbstractNioByteChannel

Returns:

the number of written messages

Throws:

Exception

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 ChannelOutboundHandler.bind(ChannelHandlerContext, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler 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 ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler 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 ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler 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 ChannelOutboundHandler.disconnect(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler 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 ChannelOutboundHandler.close(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler 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 ChannelOutboundHandler.deregister(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

write

public ChannelFuture write(Object msg)

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.

write

public ChannelFuture write(MessageList<?> msgs)

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 ChannelOutboundHandler.bind(ChannelHandlerContext, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler 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 ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler 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 ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler 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 ChannelOutboundHandler.disconnect(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler 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 ChannelOutboundHandler.close(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler 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 ChannelOutboundHandler.deregister(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler 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 ChannelInboundHandler.messageReceived(ChannelHandlerContext, MessageList) 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 ChannelOutboundHandler.read(ChannelHandlerContext) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.

write

public ChannelFuture write(Object msg,
                  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.

write

public ChannelFuture write(MessageList<?> msgs,
                  ChannelPromise promise)

pipeline

public ChannelPipeline pipeline()

Return the assigned ChannelPipeline

alloc

public io.netty.buffer.ByteBufAllocator alloc()

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

newPromise

public ChannelPromise newPromise()

Return a new ChannelPromise.

newProgressivePromise

public ChannelProgressivePromise newProgressivePromise()

Return an new ChannelProgressivePromise

newSucceededFuture

public ChannelFuture newSucceededFuture()

Create a new ChannelFuture 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.

newFailedFuture

public ChannelFuture newFailedFuture(Throwable cause)

Create a new ChannelFuture 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.

voidPromise

public ChannelPromise voidPromise()

Return a special ChannelPromise which can be reused for different operations.

It's only supported to use it for ChannelOutboundInvoker.write(Object, ChannelPromise) and, ChannelOutboundInvoker.write(MessageList, ChannelPromise).

Be aware that the returned ChannelPromise will not support most operations and should only be used if you want to safe object allocation for every operation. You will not be able to detect if the operation was complete, only if it failed as the implementation will call ChannelPipeline.fireExceptionCaught(Throwable) in this case.

Be aware this is an expert feature and should be used with care!