Package io.netty.channel.socket.nio

Class NioServerDomainSocketChannel

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

All Implemented Interfaces:

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

public final class NioServerDomainSocketChannel
extends AbstractNioMessageChannel
implements ServerChannel

A ServerChannel implementation which uses NIO selector based implementation to support UNIX Domain Sockets. This is only supported when using Java 16+.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private final class	NioServerDomainSocketChannel.NioDomainServerSocketChannelConfig

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

Modifier and Type	Field	Description
private boolean	bound
private final NioServerDomainSocketChannel.NioDomainServerSocketChannelConfig	config
private static final SelectorProvider	DEFAULT_SELECTOR_PROVIDER
private static final InternalLogger	logger
private static final ChannelMetadata	METADATA
private static final Method	OPEN_SERVER_SOCKET_CHANNEL_WITH_FAMILY

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

readInterestOp

Constructor Summary

Constructors

Constructor	Description
NioServerDomainSocketChannel()	Create a new instance
NioServerDomainSocketChannel(ServerSocketChannel channel)	Create a new instance using the given ServerSocketChannel.
NioServerDomainSocketChannel(SelectorProvider provider)	Create a new instance using the given SelectorProvider.

Method Summary

Modifier and Type	Method	Description
protected boolean	closeOnReadError(Throwable cause)
ChannelConfig	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.
boolean	isActive()	Return true if the Channel is active and so connected.
protected ServerSocketChannel	javaChannel()
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.
(package private) static ServerSocketChannel	newChannel(SelectorProvider provider)
protected SocketAddress	remoteAddress0()	Return the SocketAddress which the Channel 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, filterOutboundMessage, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, localAddress, maxMessagesPerWrite, newChannelPipeline, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, remoteAddress, 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, localAddress, parent, pipeline, read, remoteAddress, 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

OPEN_SERVER_SOCKET_CHANNEL_WITH_FAMILY

private static final Method OPEN_SERVER_SOCKET_CHANNEL_WITH_FAMILY

logger

private static final InternalLogger logger

METADATA

private static final ChannelMetadata METADATA

DEFAULT_SELECTOR_PROVIDER

private static final SelectorProvider DEFAULT_SELECTOR_PROVIDER

config

private final NioServerDomainSocketChannel.NioDomainServerSocketChannelConfig config

bound

private volatile boolean bound

Constructor Details

NioServerDomainSocketChannel

public NioServerDomainSocketChannel()

Create a new instance

NioServerDomainSocketChannel

public NioServerDomainSocketChannel(SelectorProvider provider)

Create a new instance using the given SelectorProvider.

NioServerDomainSocketChannel

public NioServerDomainSocketChannel(ServerSocketChannel channel)

Create a new instance using the given ServerSocketChannel.

Method Details

newChannel

static ServerSocketChannel newChannel(SelectorProvider provider)

javaChannel

protected ServerSocketChannel javaChannel()

Overrides:

javaChannel in class AbstractNioChannel

config

public ChannelConfig config()

Description copied from interface: Channel

Returns the configuration of this channel.

Specified by:

config in interface 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

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

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

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

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

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

doClose

protected void doClose()
                throws Exception

Description copied from class: AbstractChannel

Close the Channel

Overrides:

doClose in class AbstractNioChannel

Throws:

Exception

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

closeOnReadError

protected boolean closeOnReadError(Throwable cause)

Overrides:

closeOnReadError in class AbstractNioMessageChannel

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