Package io.netty.channel.socket.nio
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 ClassesModifier and TypeClassDescriptionprivate final class
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
FieldsModifier and TypeFieldDescriptionprivate final ServerSocketChannelConfig
private static final SelectorProvider
private static final InternalLogger
private static final ChannelMetadata
private static final Method
Fields inherited from class io.netty.channel.nio.AbstractNioChannel
readInterestOp
-
Constructor Summary
ConstructorsConstructorDescriptionCreate a new instanceCreate a new instance using the givenServerSocketChannel
.NioServerSocketChannel
(SelectorProvider provider) Create a new instance using the givenSelectorProvider
.NioServerSocketChannel
(SelectorProvider provider, InternetProtocolFamily family) Create a new instance using the givenSelectorProvider
and protocol family (supported only since JDK 15). -
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
closeOnReadError
(Throwable cause) config()
Returns the configuration of this channel.protected void
doBind
(SocketAddress localAddress) Bind theChannel
to theSocketAddress
protected void
doClose()
Close theChannel
protected boolean
doConnect
(SocketAddress remoteAddress, SocketAddress localAddress) Connect to the remote peerprotected void
Disconnect thisChannel
from its remote peerprotected void
Finish the connectprotected 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 underlyingChannel
.protected final Object
Invoked when a new message is added to aChannelOutboundBuffer
of thisAbstractChannel
, so that theChannel
implementation converts the message to another.boolean
isActive()
Returntrue
if theChannel
is active and so connected.protected ServerSocketChannel
Returns the local address where this channel is bound to.protected SocketAddress
Returns theSocketAddress
which is bound locally.metadata()
private static ServerSocketChannel
newChannel
(SelectorProvider provider, InternetProtocolFamily family) Returns the remote address where this channel is connected to.protected SocketAddress
Return theSocketAddress
which theChannel
is connected to.Methods inherited from class io.netty.channel.nio.AbstractNioMessageChannel
continueOnWriteError, continueReading, doBeginRead, doWrite, newUnsafe
Methods inherited from class io.netty.channel.nio.AbstractNioChannel
clearReadPending, doDeregister, doRegister, eventLoop, isCompatible, isOpen, isReadPending, newDirectBuffer, newDirectBuffer, selectionKey, setReadPending, unsafe
Methods inherited from class io.netty.channel.AbstractChannel
alloc, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, doShutdownOutput, equals, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, maxMessagesPerWrite, newChannelPipeline, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, toString, validateFileRegion, voidPromise, write, write, writeAndFlush, writeAndFlush
Methods inherited from class io.netty.util.DefaultAttributeMap
attr, hasAttr
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface io.netty.util.AttributeMap
attr, hasAttr
Methods inherited from interface io.netty.channel.Channel
alloc, bytesBeforeUnwritable, bytesBeforeWritable, closeFuture, eventLoop, flush, id, isOpen, isRegistered, isWritable, parent, pipeline, read, unsafe
Methods inherited from interface io.netty.channel.ChannelOutboundInvoker
bind, bind, close, close, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, voidPromise, write, write, writeAndFlush, writeAndFlush
Methods inherited from interface java.lang.Comparable
compareTo
-
Field Details
-
METADATA
-
DEFAULT_SELECTOR_PROVIDER
-
logger
-
OPEN_SERVER_SOCKET_CHANNEL_WITH_FAMILY
-
config
-
-
Constructor Details
-
NioServerSocketChannel
public NioServerSocketChannel()Create a new instance -
NioServerSocketChannel
Create a new instance using the givenSelectorProvider
. -
NioServerSocketChannel
Create a new instance using the givenSelectorProvider
and protocol family (supported only since JDK 15). -
NioServerSocketChannel
Create a new instance using the givenServerSocketChannel
.
-
-
Method Details
-
newChannel
private static ServerSocketChannel newChannel(SelectorProvider provider, InternetProtocolFamily family) -
localAddress
Description copied from interface:Channel
Returns the local address where this channel is bound to. The returnedSocketAddress
is supposed to be down-cast into more concrete type such asInetSocketAddress
to retrieve the detailed information.- Specified by:
localAddress
in interfaceChannel
- Specified by:
localAddress
in interfaceServerSocketChannel
- Overrides:
localAddress
in classAbstractChannel
- Returns:
- the local address of this channel.
null
if this channel is not bound.
-
metadata
Description copied from interface:Channel
-
config
Description copied from interface:Channel
Returns the configuration of this channel.- Specified by:
config
in interfaceChannel
- Specified by:
config
in interfaceServerSocketChannel
-
isActive
public boolean isActive()Description copied from interface:Channel
Returntrue
if theChannel
is active and so connected. -
remoteAddress
Description copied from interface:Channel
Returns the remote address where this channel is connected to. The returnedSocketAddress
is supposed to be down-cast into more concrete type such asInetSocketAddress
to retrieve the detailed information.- Specified by:
remoteAddress
in interfaceChannel
- Specified by:
remoteAddress
in interfaceServerSocketChannel
- Overrides:
remoteAddress
in classAbstractChannel
- 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
, useDefaultAddressedEnvelope.recipient()
to determine the origination of the received message as this method will returnnull
.
-
javaChannel
- Overrides:
javaChannel
in classAbstractNioChannel
-
localAddress0
Description copied from class:AbstractChannel
Returns theSocketAddress
which is bound locally.- Specified by:
localAddress0
in classAbstractChannel
-
doBind
Description copied from class:AbstractChannel
Bind theChannel
to theSocketAddress
- Specified by:
doBind
in classAbstractChannel
- Throws:
Exception
-
doClose
Description copied from class:AbstractChannel
Close theChannel
- Overrides:
doClose
in classAbstractNioChannel
- Throws:
Exception
-
doReadMessages
Description copied from class:AbstractNioMessageChannel
Read messages into the given array and return the amount which was read.- Specified by:
doReadMessages
in classAbstractNioMessageChannel
- 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 classAbstractNioChannel
- Throws:
Exception
-
doFinishConnect
Description copied from class:AbstractNioChannel
Finish the connect- Specified by:
doFinishConnect
in classAbstractNioChannel
- Throws:
Exception
-
remoteAddress0
Description copied from class:AbstractChannel
Return theSocketAddress
which theChannel
is connected to.- Specified by:
remoteAddress0
in classAbstractChannel
-
doDisconnect
Description copied from class:AbstractChannel
Disconnect thisChannel
from its remote peer- Specified by:
doDisconnect
in classAbstractChannel
- Throws:
Exception
-
doWriteMessage
Description copied from class:AbstractNioMessageChannel
Write a message to the underlyingChannel
.- Specified by:
doWriteMessage
in classAbstractNioMessageChannel
- Returns:
true
if and only if the message has been written- Throws:
Exception
-
filterOutboundMessage
Description copied from class:AbstractChannel
Invoked when a new message is added to aChannelOutboundBuffer
of thisAbstractChannel
, so that theChannel
implementation converts the message to another. (e.g. heap buffer -> direct buffer)- Overrides:
filterOutboundMessage
in classAbstractChannel
- Throws:
Exception
-
closeOnReadError
- Overrides:
closeOnReadError
in classAbstractNioMessageChannel
-