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+.AbstractNioByteChannel.NioByteUnsafe
AbstractNioChannel.AbstractNioUnsafe, AbstractNioChannel.NioUnsafe
AbstractChannel.AbstractUnsafe
Channel.Unsafe
readInterestOp
Constructor and Description |
---|
NioDomainSocketChannel()
Create a new instance
|
NioDomainSocketChannel(Channel parent,
SocketChannel socket)
Create a new instance
|
NioDomainSocketChannel(SelectorProvider provider)
Create a new instance using the given
SelectorProvider . |
NioDomainSocketChannel(SocketChannel socket)
Create a new instance using the given
SocketChannel . |
Modifier and Type | Method and 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)
|
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 . |
clearOpWrite, doWrite0, filterOutboundMessage, incompleteWrite, metadata, setOpWrite
clearReadPending, doBeginRead, doDeregister, doRegister, eventLoop, isCompatible, isOpen, isReadPending, newDirectBuffer, newDirectBuffer, selectionKey, setReadPending, unsafe
alloc, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, equals, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, localAddress, maxMessagesPerWrite, newChannelPipeline, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, pipeline, read, remoteAddress, toString, validateFileRegion, voidPromise, write, write, writeAndFlush, writeAndFlush
attr, hasAttr
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
alloc, bytesBeforeUnwritable, bytesBeforeWritable, closeFuture, eventLoop, flush, id, isOpen, isRegistered, isWritable, localAddress, metadata, pipeline, read, remoteAddress, unsafe
attr, hasAttr
bind, bind, close, close, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, voidPromise, write, write, writeAndFlush, writeAndFlush
compareTo
public NioDomainSocketChannel()
public NioDomainSocketChannel(SelectorProvider provider)
SelectorProvider
.public NioDomainSocketChannel(SocketChannel socket)
SocketChannel
.public NioDomainSocketChannel(Channel parent, SocketChannel socket)
parent
- the Channel
which created this instance or null
if it was created by the usersocket
- the SocketChannel
which will be usedpublic ServerChannel parent()
Channel
parent
in interface Channel
parent
in class AbstractChannel
null
if this channel does not have a parent channel.public ChannelConfig config()
Channel
protected SocketChannel javaChannel()
javaChannel
in class AbstractNioChannel
public boolean isActive()
Channel
true
if the Channel
is active and so connected.public boolean isOutputShutdown()
isOutputShutdown
in interface DuplexChannel
Socket.isOutputShutdown()
public boolean isInputShutdown()
DuplexChannel
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()
.isInputShutdown
in interface DuplexChannel
public boolean isShutdown()
DuplexChannel
isShutdown
in interface DuplexChannel
protected void doShutdownOutput() throws Exception
AbstractChannel
doShutdownOutput
in class AbstractChannel
Exception
public ChannelFuture shutdownOutput()
shutdownOutput
in interface DuplexChannel
Socket.shutdownOutput()
public ChannelFuture shutdownOutput(ChannelPromise promise)
DuplexChannel
ChannelPromise
.shutdownOutput
in interface DuplexChannel
Socket.shutdownOutput()
public ChannelFuture shutdownInput()
AbstractNioByteChannel
shutdownInput
in interface DuplexChannel
shutdownInput
in class AbstractNioByteChannel
Socket.shutdownInput()
protected boolean isInputShutdown0()
isInputShutdown0
in class AbstractNioByteChannel
public ChannelFuture shutdownInput(ChannelPromise promise)
DuplexChannel
ChannelPromise
.shutdownInput
in interface DuplexChannel
Socket.shutdownInput()
public ChannelFuture shutdown()
DuplexChannel
shutdown
in interface DuplexChannel
public ChannelFuture shutdown(ChannelPromise promise)
DuplexChannel
shutdown
in interface DuplexChannel
promise
- will be completed when both shutdown operations complete.protected SocketAddress localAddress0()
AbstractChannel
SocketAddress
which is bound locally.localAddress0
in class AbstractChannel
protected SocketAddress remoteAddress0()
AbstractChannel
SocketAddress
which the Channel
is connected to.remoteAddress0
in class AbstractChannel
protected void doBind(SocketAddress localAddress) throws Exception
AbstractChannel
Channel
to the SocketAddress
doBind
in class AbstractChannel
Exception
protected boolean doConnect(SocketAddress remoteAddress, SocketAddress localAddress) throws Exception
AbstractNioChannel
doConnect
in class AbstractNioChannel
Exception
protected void doFinishConnect() throws Exception
AbstractNioChannel
doFinishConnect
in class AbstractNioChannel
Exception
protected void doDisconnect() throws Exception
AbstractChannel
Channel
from its remote peerdoDisconnect
in class AbstractChannel
Exception
protected void doClose() throws Exception
AbstractChannel
Channel
doClose
in class AbstractNioChannel
Exception
protected int doReadBytes(ByteBuf byteBuf) throws Exception
AbstractNioByteChannel
ByteBuf
and return the amount.doReadBytes
in class AbstractNioByteChannel
Exception
protected int doWriteBytes(ByteBuf buf) throws Exception
AbstractNioByteChannel
doWriteBytes
in class AbstractNioByteChannel
buf
- the ByteBuf
from which the bytes should be writtenException
protected long doWriteFileRegion(FileRegion region) throws Exception
AbstractNioByteChannel
FileRegion
doWriteFileRegion
in class AbstractNioByteChannel
region
- the FileRegion
from which the bytes should be writtenException
protected void doWrite(ChannelOutboundBuffer in) throws Exception
AbstractChannel
doWrite
in class AbstractNioByteChannel
Exception
protected AbstractNioChannel.AbstractNioUnsafe newUnsafe()
AbstractChannel
AbstractChannel.AbstractUnsafe
instance which will be used for the life-time of the Channel
newUnsafe
in class AbstractNioByteChannel
Copyright © 2008–2024 The Netty Project. All rights reserved.