Package io.netty.channel.socket.nio

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, java.lang.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 io.netty.channel.nio.AbstractNioByteChannel

AbstractNioByteChannel.NioByteUnsafe

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, readOps

Constructor Summary

Constructors

Constructor	Description
NioDomainSocketChannel()	Create a new instance
NioDomainSocketChannel(Channel parent, java.nio.channels.SocketChannel socket)	Create a new instance
NioDomainSocketChannel(java.nio.channels.SocketChannel socket)	Create a new instance using the given SocketChannel.
NioDomainSocketChannel(java.nio.channels.spi.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(java.net.SocketAddress localAddress)	Bind the Channel to the SocketAddress
protected void	doClose()	Close the Channel
protected boolean	doConnect(java.net.SocketAddress remoteAddress, java.net.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 java.nio.channels.SocketChannel	javaChannel()
protected java.net.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 java.net.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 io.netty.channel.nio.AbstractNioByteChannel

clearOpWrite, doWrite0, filterOutboundMessage, incompleteWrite, metadata, setOpWrite

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

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

Methods inherited from class io.netty.channel.AbstractChannel

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

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, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, closeFuture, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, eventLoop, flush, getOption, id, isOpen, isRegistered, isWritable, localAddress, metadata, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, pipeline, read, remoteAddress, setOption, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

NioDomainSocketChannel

public NioDomainSocketChannel()

Create a new instance

NioDomainSocketChannel

public NioDomainSocketChannel(java.nio.channels.spi.SelectorProvider provider)

Create a new instance using the given SelectorProvider.

NioDomainSocketChannel

public NioDomainSocketChannel(java.nio.channels.SocketChannel socket)

Create a new instance using the given SocketChannel.

NioDomainSocketChannel

public NioDomainSocketChannel(Channel parent,
                              java.nio.channels.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 Detail

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 java.nio.channels.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 java.lang.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:

java.lang.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 java.net.SocketAddress localAddress0()

Description copied from class: AbstractChannel

Returns the SocketAddress which is bound locally.

Specified by:

localAddress0 in class AbstractChannel

remoteAddress0

protected java.net.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(java.net.SocketAddress localAddress)
               throws java.lang.Exception

Description copied from class: AbstractChannel

Bind the Channel to the SocketAddress

Specified by:

doBind in class AbstractChannel

Throws:

java.lang.Exception

doConnect

protected boolean doConnect(java.net.SocketAddress remoteAddress,
                            java.net.SocketAddress localAddress)
                     throws java.lang.Exception

Description copied from class: AbstractNioChannel

Connect to the remote peer

Specified by:

doConnect in class AbstractNioChannel

Throws:

java.lang.Exception

doFinishConnect

protected void doFinishConnect()
                        throws java.lang.Exception

Description copied from class: AbstractNioChannel

Finish the connect

Specified by:

doFinishConnect in class AbstractNioChannel

Throws:

java.lang.Exception

doDisconnect

protected void doDisconnect()
                     throws java.lang.Exception

Description copied from class: AbstractChannel

Disconnect this Channel from its remote peer

Specified by:

doDisconnect in class AbstractChannel

Throws:

java.lang.Exception

doClose

protected void doClose()
                throws java.lang.Exception

Description copied from class: AbstractChannel

Close the Channel

Overrides:

doClose in class AbstractNioChannel

Throws:

java.lang.Exception

doReadBytes

protected int doReadBytes(ByteBuf byteBuf)
                   throws java.lang.Exception

Description copied from class: AbstractNioByteChannel

Read bytes into the given ByteBuf and return the amount.

Specified by:

doReadBytes in class AbstractNioByteChannel

Throws:

java.lang.Exception

doWriteBytes

protected int doWriteBytes(ByteBuf buf)
                    throws java.lang.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:

java.lang.Exception

doWriteFileRegion

protected long doWriteFileRegion(FileRegion region)
                          throws java.lang.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:

java.lang.Exception

doWrite

protected void doWrite(ChannelOutboundBuffer in)
                throws java.lang.Exception

Description copied from class: AbstractChannel

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

Overrides:

doWrite in class AbstractNioByteChannel

Throws:

java.lang.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