Class NioServerSocketChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.nio.AbstractNioChannel

io.netty.channel.nio.AbstractNioMessageChannel

io.netty.channel.socket.nio.NioServerSocketChannel

All Implemented Interfaces:

Channel, ChannelOutboundInvoker, ServerChannel, ServerSocketChannel, AttributeMap, Comparable<Channel>

public class NioServerSocketChannel
extends AbstractNioMessageChannel
implements ServerSocketChannel

A ServerSocketChannel implementation which uses NIO selector based implementation to accept new connections.

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

Constructor	Description
NioServerSocketChannel()	Create a new instance
NioServerSocketChannel(ServerSocketChannel channel)	Create a new instance using the given ServerSocketChannel.
NioServerSocketChannel(SelectorProvider provider)	Create a new instance using the given SelectorProvider.
NioServerSocketChannel(SelectorProvider provider, InternetProtocolFamily family)	Deprecated. use NioServerSocketChannel(SelectorProvider, SocketProtocolFamily)
NioServerSocketChannel(SelectorProvider provider, SocketProtocolFamily family)	Create a new instance using the given SelectorProvider and protocol family (supported only since JDK 15).

Method Summary

Modifier and Type	Method	Description
protected boolean	closeOnReadError(Throwable cause)
ServerSocketChannelConfig	config()	Returns the configuration of this channel.
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	doReadMessages(List<Object> buf)	Read messages into the given array and return the amount which was read.
protected boolean	doWriteMessage(Object msg, ChannelOutboundBuffer in)	Write a message to the underlying Channel.
protected final 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.
boolean	isActive()	Return true if the Channel is active and so connected.
protected ServerSocketChannel	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.
InetSocketAddress	remoteAddress()	Returns the remote address where this channel is connected to.
protected SocketAddress	remoteAddress0()	Return the SocketAddress which the Channel is connected to.

Methods inherited from class AbstractNioMessageChannel

continueOnWriteError, continueReading, doBeginRead, doWrite, newUnsafe

Methods inherited from class AbstractNioChannel

addAndSubmit, clearReadPending, doDeregister, doRegister, isCompatible, isOpen, isReadPending, newDirectBuffer, newDirectBuffer, registration, removeAndSubmit, selectionKey, setReadPending, unsafe

Methods inherited from class AbstractChannel

closeFuture, compareTo, doRegister, doShutdownOutput, equals, eventLoop, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, maxMessagesPerWrite, newChannelPipeline, newId, parent, pipeline, 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, closeFuture, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, eventLoop, flush, getOption, id, isOpen, isRegistered, isWritable, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, setOption, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from interface Comparable

compareTo

Constructor Details

NioServerSocketChannel

public NioServerSocketChannel()

Create a new instance

NioServerSocketChannel

public NioServerSocketChannel(SelectorProvider provider)

Create a new instance using the given SelectorProvider.

NioServerSocketChannel

@Deprecated
public NioServerSocketChannel(SelectorProvider provider,
 InternetProtocolFamily family)

Deprecated.

use NioServerSocketChannel(SelectorProvider, SocketProtocolFamily)

Create a new instance using the given SelectorProvider and protocol family (supported only since JDK 15).

NioServerSocketChannel

public NioServerSocketChannel(SelectorProvider provider,
 SocketProtocolFamily family)

Create a new instance using the given SelectorProvider and protocol family (supported only since JDK 15).

NioServerSocketChannel

public NioServerSocketChannel(ServerSocketChannel channel)

Create a new instance using the given ServerSocketChannel.

Method Details

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 ServerSocketChannel

Overrides:

localAddress in class AbstractChannel

Returns:

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

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 ServerSocketChannelConfig config()

Description copied from interface: Channel

Returns the configuration of this channel.

Specified by:

config in interface Channel

Specified by:

config in interface ServerSocketChannel

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

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 ServerSocketChannel

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.

javaChannel

protected ServerSocketChannel javaChannel()

Overrides:

javaChannel in class AbstractNioChannel

localAddress0

protected SocketAddress localAddress0()

Description copied from class: AbstractChannel

Returns the SocketAddress which is bound locally.

Specified by:

localAddress0 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

doClose

protected void doClose()
                throws Exception

Description copied from class: AbstractChannel

Close the Channel

Overrides:

doClose in class AbstractNioChannel

Throws:

Exception

doReadMessages

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

Description copied from class: AbstractNioMessageChannel

Read messages into the given array and return the amount which was read.

Specified by:

doReadMessages in class AbstractNioMessageChannel

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

remoteAddress0

protected SocketAddress remoteAddress0()

Description copied from class: AbstractChannel

Return the SocketAddress which the Channel is connected to.

Specified by:

remoteAddress0 in class AbstractChannel

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

doWriteMessage

protected boolean doWriteMessage(Object msg,
 ChannelOutboundBuffer in)
                          throws Exception

Description copied from class: AbstractNioMessageChannel

Write a message to the underlying Channel.

Specified by:

doWriteMessage in class AbstractNioMessageChannel

Returns:

true if and only if the message has been written

Throws:

Exception

filterOutboundMessage

protected final Object filterOutboundMessage(Object msg)
                                      throws Exception

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

Throws:

Exception

closeOnReadError

protected boolean closeOnReadError(Throwable cause)

Overrides:

closeOnReadError in class AbstractNioMessageChannel