Class NioDomainSocketChannel

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

All Implemented Interfaces:

Channel, ChannelOutboundInvoker, DuplexChannel, AttributeMap, Comparable<Channel>

public final class NioDomainSocketChannel
extends AbstractNioByteChannel
implements DuplexChannel

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

Nested Class Summary

Nested classes/interfaces inherited from class AbstractNioByteChannel

AbstractNioByteChannel.NioByteUnsafe

Modifier and Type	Class	Description
protected class	AbstractNioByteChannel.NioByteUnsafe

Nested classes/interfaces inherited from class AbstractNioChannel

AbstractNioChannel.AbstractNioUnsafe, AbstractNioChannel.NioUnsafe

Modifier and Type	Class	Description
protected class	AbstractNioChannel.AbstractNioUnsafe
static interface	AbstractNioChannel.NioUnsafe	Special Channel.Unsafe sub-type which allows to access the underlying SelectableChannel

Nested classes/interfaces inherited from class AbstractChannel

AbstractChannel.AbstractUnsafe

Modifier and Type	Class	Description
protected class	AbstractChannel.AbstractUnsafe	Channel.Unsafe implementation which sub-classes must extend and use.

Nested classes/interfaces inherited from interface Channel

Channel.Unsafe

Modifier and Type	Interface	Description
static interface	Channel.Unsafe	Unsafe operations that should never be called from user-code.

Field Summary

Fields inherited from class AbstractNioChannel

readInterestOp, readOps

Modifier and Type	Field	Description
protected final int	readInterestOp
protected final NioIoOps	readOps

Constructor Summary

Constructors

Constructor	Description
NioDomainSocketChannel()	Create a new instance
NioDomainSocketChannel(Channel parent, SocketChannel socket)	Create a new instance
NioDomainSocketChannel(SocketChannel socket)	Create a new instance using the given SocketChannel.
NioDomainSocketChannel(SelectorProvider provider)	Create a new instance using the given SelectorProvider.

Method Summary

Modifier and Type	Method	Description
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	doReadBytes(ByteBuf byteBuf)	Read bytes into the given ByteBuf and return the amount.
protected void	doShutdownOutput()	Called when conditions justify shutting down the output portion of the channel.
protected void	doWrite(ChannelOutboundBuffer in)	Flush the content of the given buffer to the remote peer.
protected int	doWriteBytes(ByteBuf buf)	Write bytes form the given ByteBuf to the underlying Channel.
protected long	doWriteFileRegion(FileRegion region)	Write a FileRegion
boolean	isActive()	Return true if the Channel is active and so connected.
boolean	isInputShutdown()	Returns true if and only if the remote peer shut down its output so that no more data is received from this channel.
protected boolean	isInputShutdown0()
boolean	isOutputShutdown()
boolean	isShutdown()	Determine if both the input and output of this channel have been shutdown.
protected SocketChannel	javaChannel()
protected SocketAddress	localAddress0()	Returns the SocketAddress which is bound locally.
protected AbstractNioChannel.AbstractNioUnsafe	newUnsafe()	Create a new AbstractChannel.AbstractUnsafe instance which will be used for the life-time of the Channel
ServerChannel	parent()	Returns the parent of this channel.
protected SocketAddress	remoteAddress0()	Return the SocketAddress which the Channel is connected to.
ChannelFuture	shutdown()	Will shutdown the input and output sides of this channel.
ChannelFuture	shutdown(ChannelPromise promise)	Will shutdown the input and output sides of this channel.
ChannelFuture	shutdownInput()	Shutdown the input side of the channel.
ChannelFuture	shutdownInput(ChannelPromise promise)	Will shutdown the input and notify ChannelPromise.
ChannelFuture	shutdownOutput()
ChannelFuture	shutdownOutput(ChannelPromise promise)	Will shutdown the output and notify ChannelPromise.

Methods inherited from class AbstractNioByteChannel

clearOpWrite, doWrite0, filterOutboundMessage, incompleteWrite, metadata, setOpWrite

Modifier and Type	Method	Description
protected final void	clearOpWrite()
protected final int	doWrite0(ChannelOutboundBuffer in)	Write objects to the OS.
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.
protected final void	incompleteWrite(boolean setOpWrite)
ChannelMetadata	metadata()	Return the ChannelMetadata of the Channel which describe the nature of the Channel.
protected final void	setOpWrite()

Methods inherited from class AbstractNioChannel

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

Modifier and Type	Method	Description
protected void	addAndSubmit(NioIoOps addOps)
protected final void	clearReadPending()	Set read pending to false.
protected void	doBeginRead()	Schedule a read operation.
protected void	doDeregister()	Deregister the Channel from its EventLoop.
protected void	doRegister(ChannelPromise promise)	Is called after the Channel is registered with its EventLoop as part of the register process.
protected boolean	isCompatible(EventLoop loop)	Return true if the given EventLoop is compatible with this instance.
boolean	isOpen()	Returns true if the Channel is open and may get active later
protected boolean	isReadPending()	Deprecated. No longer supported.
protected final ByteBuf	newDirectBuffer(ByteBuf buf)	Returns an off-heap copy of the specified ByteBuf, and releases the original one.
protected final ByteBuf	newDirectBuffer(ReferenceCounted holder, ByteBuf buf)	Returns an off-heap copy of the specified ByteBuf, and releases the specified holder.
protected IoRegistration	registration()
protected void	removeAndSubmit(NioIoOps removeOps)
protected SelectionKey	selectionKey()	Deprecated. use AbstractNioChannel.registration.
protected void	setReadPending(boolean readPending)	Deprecated. Use AbstractNioChannel.clearReadPending() if appropriate instead.
AbstractNioChannel.NioUnsafe	unsafe()	Returns an internal-use-only object that provides unsafe operations.

Methods inherited from class AbstractChannel

closeFuture, compareTo, doRegister, equals, eventLoop, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, localAddress, maxMessagesPerWrite, newChannelPipeline, newId, pipeline, remoteAddress, toString, validateFileRegion, voidPromise

Modifier and Type	Method	Description
ChannelFuture	closeFuture()	Returns the ChannelFuture which will be notified when this channel is closed.
final int	compareTo(Channel o)
protected void	doRegister()	Deprecated. use AbstractChannel.doRegister(ChannelPromise)
final boolean	equals(Object o)	Returns true if and only if the specified object is identical with this channel (i.e: this == o).
EventLoop	eventLoop()	Return the EventLoop this Channel was registered to.
final int	hashCode()	Returns the ID of this channel.
final ChannelId	id()	Returns the globally unique identifier of this Channel.
protected void	invalidateLocalAddress()	Deprecated. no use-case for this.
protected void	invalidateRemoteAddress()	Deprecated. no use-case for this.
boolean	isRegistered()	Returns true if the Channel is registered with an EventLoop.
SocketAddress	localAddress()	Returns the local address where this channel is bound to.
protected final int	maxMessagesPerWrite()
protected DefaultChannelPipeline	newChannelPipeline()	Returns a new DefaultChannelPipeline instance.
protected ChannelId	newId()	Returns a new DefaultChannelId instance.
ChannelPipeline	pipeline()	Return the assigned ChannelPipeline.
SocketAddress	remoteAddress()	Returns the remote address where this channel is connected to.
String	toString()	Returns the String representation of this channel.
protected void	validateFileRegion(DefaultFileRegion region, long position)
final ChannelPromise	voidPromise()	Return a special ChannelPromise which can be reused for different operations.

Methods inherited from class DefaultAttributeMap

attr, hasAttr

Modifier and Type	Method	Description
<T> Attribute<T>	attr(AttributeKey<T> key)	Get the Attribute for the given AttributeKey.
<T> boolean	hasAttr(AttributeKey<T> key)	Returns true if and only if the given Attribute exists in this AttributeMap.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Channel

alloc, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, flush, getOption, isWritable, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, read, setOption, write, write, writeAndFlush, writeAndFlush

Modifier and Type	Method	Description
default ByteBufAllocator	alloc()	Return the assigned ByteBufAllocator which will be used to allocate ByteBufs.
default 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.
default 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.
default long	bytesBeforeUnwritable()	Get how many bytes can be written until Channel.isWritable() returns false.
default long	bytesBeforeWritable()	Get how many bytes must be drained from underlying buffers until Channel.isWritable() returns true.
default ChannelFuture	close()	Request to close the Channel and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
default ChannelFuture	close(ChannelPromise promise)	Request to close the Channel and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
default 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.
default 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.
default 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.
default 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.
default ChannelFuture	deregister()	Request to deregister from the previous assigned EventExecutor and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
default ChannelFuture	deregister(ChannelPromise promise)	Request to deregister from the previous assigned EventExecutor and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
default ChannelFuture	disconnect()	Request to disconnect from the remote peer and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
default ChannelFuture	disconnect(ChannelPromise promise)	Request to disconnect from the remote peer and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
default Channel	flush()	Request to flush all pending messages via this ChannelOutboundInvoker.
default <T> T	getOption(ChannelOption<T> option)	Return the value of the given ChannelOption
default boolean	isWritable()	Returns true if and only if the I/O thread will perform the requested write operation immediately.
default ChannelFuture	newFailedFuture(Throwable cause)	Create a new ChannelFuture which is marked as failed already.
default ChannelProgressivePromise	newProgressivePromise()	Return an new ChannelProgressivePromise
default ChannelPromise	newPromise()	Return a new ChannelPromise.
default ChannelFuture	newSucceededFuture()	Create a new ChannelFuture which is marked as succeeded already.
default Channel	read()	Request to Read data from the Channel into the first inbound buffer, triggers an ChannelInboundHandler.channelRead(ChannelHandlerContext, Object) event if data was read, and triggers a channelReadComplete event so the handler can decide to continue reading.
default <T> boolean	setOption(ChannelOption<T> option, T value)	Sets a configuration property with the specified name and value.
default ChannelFuture	write(Object msg)	Request to write a message via this ChannelHandlerContext through the ChannelPipeline.
default ChannelFuture	write(Object msg, ChannelPromise promise)	Request to write a message via this ChannelHandlerContext through the ChannelPipeline.
default ChannelFuture	writeAndFlush(Object msg)	Shortcut for call ChannelOutboundInvoker.write(Object) and ChannelOutboundInvoker.flush().
default ChannelFuture	writeAndFlush(Object msg, ChannelPromise promise)	Shortcut for call ChannelOutboundInvoker.write(Object, ChannelPromise) and ChannelOutboundInvoker.flush().

Constructor Details

NioDomainSocketChannel

public NioDomainSocketChannel()

Create a new instance

NioDomainSocketChannel

public NioDomainSocketChannel(SelectorProvider provider)

Create a new instance using the given SelectorProvider.

NioDomainSocketChannel

public NioDomainSocketChannel(SocketChannel socket)

Create a new instance using the given SocketChannel.

NioDomainSocketChannel

public NioDomainSocketChannel(Channel parent,
 SocketChannel socket)

Create a new instance

Parameters:

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

socket - the SocketChannel which will be used

Method Details

parent

public ServerChannel parent()

Description copied from interface: Channel

Returns the parent of this channel.

Specified by:

parent in interface Channel

Overrides:

parent in class AbstractChannel

Returns:

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

config

public ChannelConfig config()

Description copied from interface: Channel

Returns the configuration of this channel.

Specified by:

config in interface Channel

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

isOutputShutdown

public boolean isOutputShutdown()

Specified by:

isOutputShutdown in interface DuplexChannel

See Also:

• Socket.isOutputShutdown()

isInputShutdown

public boolean isInputShutdown()

Description copied from interface: DuplexChannel

Returns true if and only if the remote peer shut down its output so that no more data is received from this channel. Note that the semantic of this method is different from that of Socket.shutdownInput() and Socket.isInputShutdown().

Specified by:

isInputShutdown in interface DuplexChannel

isShutdown

public boolean isShutdown()

Description copied from interface: DuplexChannel

Determine if both the input and output of this channel have been shutdown.

Specified by:

isShutdown in interface DuplexChannel

doShutdownOutput

protected void doShutdownOutput()
                         throws Exception

Description copied from class: AbstractChannel

Called when conditions justify shutting down the output portion of the channel. This may happen if a write operation throws an exception.

Overrides:

doShutdownOutput in class AbstractChannel

Throws:

Exception

shutdownOutput

public ChannelFuture shutdownOutput()

Specified by:

shutdownOutput in interface DuplexChannel

See Also:

• Socket.shutdownOutput()

shutdownOutput

public ChannelFuture shutdownOutput(ChannelPromise promise)

Description copied from interface: DuplexChannel

Will shutdown the output and notify ChannelPromise.

Specified by:

shutdownOutput in interface DuplexChannel

See Also:

• Socket.shutdownOutput()

shutdownInput

public ChannelFuture shutdownInput()

Description copied from class: AbstractNioByteChannel

Shutdown the input side of the channel.

Specified by:

shutdownInput in interface DuplexChannel

Specified by:

shutdownInput in class AbstractNioByteChannel

See Also:

• Socket.shutdownInput()

isInputShutdown0

protected boolean isInputShutdown0()

Overrides:

isInputShutdown0 in class AbstractNioByteChannel

shutdownInput

public ChannelFuture shutdownInput(ChannelPromise promise)

Description copied from interface: DuplexChannel

Will shutdown the input and notify ChannelPromise.

Specified by:

shutdownInput in interface DuplexChannel

See Also:

• Socket.shutdownInput()

shutdown

public ChannelFuture shutdown()

Description copied from interface: DuplexChannel

Will shutdown the input and output sides of this channel.

Specified by:

shutdown in interface DuplexChannel

Returns:

will be completed when both shutdown operations complete.

shutdown

public ChannelFuture shutdown(ChannelPromise promise)

Description copied from interface: DuplexChannel

Will shutdown the input and output sides of this channel.

Specified by:

shutdown in interface DuplexChannel

Parameters:

promise - will be completed when both shutdown operations complete.

Returns:

will be completed when both shutdown operations complete.

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

Overrides:

doClose in class AbstractNioChannel

Throws:

Exception

doReadBytes

protected int doReadBytes(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(ByteBuf buf)
                    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

Returns:

amount the amount of written bytes

Throws:

Exception

doWriteFileRegion

protected long doWriteFileRegion(FileRegion region)
                          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

Returns:

amount the amount of written bytes

Throws:

Exception

doWrite

protected void doWrite(ChannelOutboundBuffer in)
                throws Exception

Description copied from class: AbstractChannel

Flush the content of the given buffer to the remote peer.

Overrides:

doWrite in class AbstractNioByteChannel

Throws:

Exception

newUnsafe

protected AbstractNioChannel.AbstractNioUnsafe newUnsafe()

Description copied from class: AbstractChannel

Create a new AbstractChannel.AbstractUnsafe instance which will be used for the life-time of the Channel

Overrides:

newUnsafe in class AbstractNioByteChannel