`ChannelOption`	`INET`	`INET6`	`UNIX`
`IntegerUnixChannelOption`	X	X	X
`RawUnixChannelOption`	X	X	X
`KQueueChannelOption#SO_SNDLOWAT`	X	X	-
`KQueueChannelOption#TCP_NOPUSH`	X	X	-
`ChannelOption#TCP_FASTOPEN_CONNECT`	X	X	-

Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	KQueueSocketChannel.KQueueSocketWritableByteChannel

Field Summary

Modifier and Type	Field and Description
private WritableByteChannel	byteChannel
private static final String	EXPECTED_TYPES
private volatile DomainSocketReadMode	mode
private static final Set<ChannelOption<?>>	SUPPORTED_OPTIONS
private static final Set<ChannelOption<?>>	SUPPORTED_OPTIONS_DOMAIN_SOCKET
private volatile boolean	tcpFastopen

Inherited from io.netty5.channel.kqueue.AbstractKQueueChannel:: active socket

Constructor Summary

Access	Constructor and Description
public	KQueueSocketChannel(EventLoop eventLoop)
public	KQueueSocketChannel(EventLoop eventLoop, ProtocolFamily protocolFamily)
public	KQueueSocketChannel(EventLoop eventLoop, int fd, ProtocolFamily protocolFamily)
private	KQueueSocketChannel(EventLoop eventLoop, BsdSocket fd)
pack-priv	KQueueSocketChannel(KQueueServerSocketChannel parent, EventLoop eventLoop, BsdSocket fd, SocketAddress remoteAddress)

Method Summary

Modifier and Type	Method and Description
protected boolean	doConnect0(SocketAddress remoteAddress, SocketAddress localAddress, Buffer initialData) Overrides io.netty5.channel.kqueue.AbstractKQueueChannel.doConnect0.
protected void	doShutdown(ChannelShutdownDirection the direction to shut down. direction) Implements abstract io.netty5.channel.AbstractChannel.doShutdown. Shutdown one direction of the `Channel`.
private void	doWriteMultiple(AbstractChannel<KQueueServerSocketChannel, SocketAddress, SocketAddress>.WriteSink the `WriteSink` used. writeSink) Attempt to write multiple `Buffer` objects.
protected void	doWriteNow(AbstractChannel<KQueueServerSocketChannel, SocketAddress, SocketAddress>.WriteSink the `WriteSink` that must be completed with the write progress. `WriteSink#complete(long, long, int, boolean)` or `WriteSink#complete(long, Throwable, boolean)` must be called exactly once before this method returns non-exceptional. writeSink) Implements abstract io.netty5.channel.AbstractChannel.doWriteNow. Called in a loop when writes should be performed until this method returns `false` or there are no more messages to write.
private void	doWriteSingle(AbstractChannel<KQueueServerSocketChannel, SocketAddress, SocketAddress>.WriteSink the `WriteSink` used. writeSink) Attempt to write a single object.
private void	enableTcpNoDelayIfSupported()
protected Object	filterOutboundMessage(Object the message to filter / convert. msg) Overrides io.netty5.channel.AbstractChannel.filterOutboundMessage. Invoked when a new message is added to to the outbound queue of this `AbstractChannel`, so that the `Channel` implementation converts the message to another.
protected <T> T	getExtendedOption(ChannelOption<T> the `ChannelOption`. option) Overrides io.netty5.channel.kqueue.AbstractKQueueChannel.getExtendedOption. Override to add support for more `ChannelOption`s.
private PeerCredentials	getPeerCredentials()
private DomainSocketReadMode	getReadMode()
private int	getReceiveBufferSize()
private int	getSendBufferSize()
private int	getSndLowAt()
private int	getSoLinger()
private int	getTrafficClass()
protected boolean	isExtendedOptionSupported(ChannelOption<?> the `ChannelOption`. option) Overrides io.netty5.channel.kqueue.AbstractKQueueChannel.isExtendedOptionSupported. Override to add support for more `ChannelOption`s.
private boolean	isKeepAlive()
private boolean	isReuseAddress()
public boolean	isShutdown(ChannelShutdownDirection direction) Implements io.netty5.channel.Channel.isShutdown. Returns `true` if the `ChannelShutdownDirection` of the `Channel` was shutdown before.
private boolean	isSupported(SocketProtocolFamily protocolFamily, ChannelOption<?> option)
private boolean	isTcpFastOpenConnect() Returns `true` if TCP fast open is enabled, `false` otherwise.
private boolean	isTcpNoDelay()
private boolean	isTcpNoPush()
protected Future<Executor>	prepareToClose() Overrides io.netty5.channel.AbstractChannel.prepareToClose. Prepares to close the `Channel`.
pack-priv int	readReady(AbstractChannel<KQueueServerSocketChannel, SocketAddress, SocketAddress>.ReadSink readSink) Implements abstract io.netty5.channel.kqueue.AbstractKQueueChannel.readReady.
private int	readReadyBytes(AbstractChannel<KQueueServerSocketChannel, SocketAddress, SocketAddress>.ReadSink readSink)
private int	readReadyFd(AbstractChannel<KQueueServerSocketChannel, SocketAddress, SocketAddress>.ReadSink readSink)
protected <T> void	setExtendedOption(ChannelOption<T> the `ChannelOption`. option, T value) Overrides io.netty5.channel.kqueue.AbstractKQueueChannel.setExtendedOption. Override to add support for more `ChannelOption`s.
private void	setKeepAlive(boolean keepAlive)
private void	setReadMode(DomainSocketReadMode mode)
private void	setReceiveBufferSize(int receiveBufferSize)
private void	setReuseAddress(boolean reuseAddress)
private void	setSendBufferSize(int sendBufferSize)
private void	setSndLowAt(int sndLowAt)
private void	setSoLinger(int soLinger)
private void	setTcpFastOpenConnect(boolean fastOpenConnect) Enables client TCP fast open, if available.
private void	setTcpNoDelay(boolean tcpNoDelay)
private void	setTcpNoPush(boolean tcpNoPush)
private void	setTrafficClass(int trafficClass)
private static Set<ChannelOption<?>>	supportedOptions() Hides io.netty5.channel.AbstractChannel.supportedOptions.
private static Set<ChannelOption<?>>	supportedOptionsDomainSocket()
private void	writeBytes(AbstractChannel<KQueueServerSocketChannel, SocketAddress, SocketAddress>.WriteSink the `WriteSink` used. writeSink) Write bytes form the given `Buffer` to the underlying `java.nio.channels.Channel`.
private long	Returns: number of written bytes. writeBytesMultiple(IovArray The array which contains the content to write. array) Write multiple bytes via `IovArray`.
private long	Returns: number of written bytes. writeBytesMultiple(ByteBuffer[] The buffers to write. nioBuffers, int The number of buffers to write. nioBufferCnt, long The number of bytes we expect to write. expectedWrittenBytes, long The maximum number of bytes we should attempt to write. maxBytesPerGatheringWrite) Write multiple bytes via `ByteBuffer` array.
private void	writeDefaultFileRegion(AbstractChannel<KQueueServerSocketChannel, SocketAddress, SocketAddress>.WriteSink the `WriteSink` used. writeSink) Write a `DefaultFileRegion`
private void	writeFileRegion(AbstractChannel<KQueueServerSocketChannel, SocketAddress, SocketAddress>.WriteSink the `WriteSink` used. writeSink) Write a `FileRegion`

Field Detail

byteChannel	back to summary
private WritableByteChannel byteChannel

EXPECTED_TYPES	back to summary
private static final String EXPECTED_TYPES

mode	back to summary
private volatile DomainSocketReadMode mode

SUPPORTED_OPTIONS	back to summary
private static final Set<ChannelOption<?>> SUPPORTED_OPTIONS

SUPPORTED_OPTIONS_DOMAIN_SOCKET	back to summary
private static final Set<ChannelOption<?>> SUPPORTED_OPTIONS_DOMAIN_SOCKET

tcpFastopen	back to summary
private volatile boolean tcpFastopen

Constructor Detail

KQueueSocketChannel	back to summary
public KQueueSocketChannel(EventLoop eventLoop)

KQueueSocketChannel	back to summary
public KQueueSocketChannel(EventLoop eventLoop, ProtocolFamily protocolFamily)

KQueueSocketChannel	back to summary
public KQueueSocketChannel(EventLoop eventLoop, int fd, ProtocolFamily protocolFamily)

KQueueSocketChannel	back to summary
private KQueueSocketChannel(EventLoop eventLoop, BsdSocket fd)

KQueueSocketChannel	back to summary
pack-priv KQueueSocketChannel(KQueueServerSocketChannel parent, EventLoop eventLoop, BsdSocket fd, SocketAddress remoteAddress)

Method Detail

doConnect0	back to summary
protected boolean doConnect0(SocketAddress remoteAddress, SocketAddress localAddress, Buffer initialData) throws Exception Overrides io.netty5.channel.kqueue.AbstractKQueueChannel.doConnect0. Annotations @Override

doConnect0

back to summary

protected boolean doConnect0(SocketAddress remoteAddress, SocketAddress localAddress, Buffer initialData) throws Exception

Overrides io.netty5.channel.kqueue.AbstractKQueueChannel.doConnect0.

Annotations

@Override

doShutdown back to summary

doShutdown	back to summary
protected void doShutdown(ChannelShutdownDirection direction) throws Exception Implements abstract io.netty5.channel.AbstractChannel.doShutdown. Doc from io.netty5.channel.AbstractChannel.doShutdown. Shutdown one direction of the `Channel`. Parameters direction:ChannelShutdownDirection the direction to shut down. Annotations @Override Exceptions Exception: thrown on error.

protected void doShutdown(ChannelShutdownDirection direction) throws Exception

Implements abstract io.netty5.channel.AbstractChannel.doShutdown.

Doc from io.netty5.channel.AbstractChannel.doShutdown.

Shutdown one direction of the Channel.

Parameters

direction:ChannelShutdownDirection: the direction to shut down.

Annotations

@Override

Exceptions

Exception:: thrown on error.

doWriteMultiple back to summary

doWriteMultiple	back to summary
private void doWriteMultiple(AbstractChannel<KQueueServerSocketChannel, SocketAddress, SocketAddress>.WriteSink writeSink) throws Exception Attempt to write multiple `Buffer` objects. Parameters writeSink:AbstractChannel<KQueueServerSocketChannel, SocketAddress, SocketAddress>.WriteSink the `WriteSink` used. Exceptions Exception: If an I/O error occurs.

private void doWriteMultiple(AbstractChannel<KQueueServerSocketChannel, SocketAddress, SocketAddress>.WriteSink writeSink) throws Exception

Attempt to write multiple Buffer objects.

Parameters

writeSink:AbstractChannel<KQueueServerSocketChannel, SocketAddress, SocketAddress>.WriteSink: the WriteSink used.

Exceptions

Exception:: If an I/O error occurs.

doWriteNow back to summary

doWriteNow	back to summary
protected void doWriteNow(AbstractChannel<KQueueServerSocketChannel, SocketAddress, SocketAddress>.WriteSink writeSink) throws Exception Implements abstract io.netty5.channel.AbstractChannel.doWriteNow. Doc from io.netty5.channel.AbstractChannel.doWriteNow. Called in a loop when writes should be performed until this method returns `false` or there are no more messages to write. Implementations are responsible for handling partial writes, which for example means that if `Buffer`s are written partial implementations need to ensure the `readerOffset` is updated accordingly. Parameters writeSink:AbstractChannel<KQueueServerSocketChannel, SocketAddress, SocketAddress>.WriteSink the `WriteSink` that must be completed with the write progress. `WriteSink#complete(long, long, int, boolean)` or `WriteSink#complete(long, Throwable, boolean)` must be called exactly once before this method returns non-exceptional. Annotations @Override Exceptions Exception: if an error happened during writing. This will also terminate the write loop.

protected void doWriteNow(AbstractChannel<KQueueServerSocketChannel, SocketAddress, SocketAddress>.WriteSink writeSink) throws Exception

Implements abstract io.netty5.channel.AbstractChannel.doWriteNow.

Doc from io.netty5.channel.AbstractChannel.doWriteNow.

Called in a loop when writes should be performed until this method returns false or there are no more messages to write. Implementations are responsible for handling partial writes, which for example means that if Buffers are written partial implementations need to ensure the readerOffset is updated accordingly.

Parameters

writeSink:AbstractChannel<KQueueServerSocketChannel, SocketAddress, SocketAddress>.WriteSink: the WriteSink that must be completed with the write progress. WriteSink#complete(long, long, int, boolean) or WriteSink#complete(long, Throwable, boolean) must be called exactly once before this method returns non-exceptional.

Annotations

@Override

Exceptions

Exception:: if an error happened during writing. This will also terminate the write loop.

doWriteSingle back to summary

doWriteSingle	back to summary
private void doWriteSingle(AbstractChannel<KQueueServerSocketChannel, SocketAddress, SocketAddress>.WriteSink writeSink) throws Exception Attempt to write a single object. Parameters writeSink:AbstractChannel<KQueueServerSocketChannel, SocketAddress, SocketAddress>.WriteSink the `WriteSink` used. Exceptions Exception: If an I/O error occurs.

private void doWriteSingle(AbstractChannel<KQueueServerSocketChannel, SocketAddress, SocketAddress>.WriteSink writeSink) throws Exception

Attempt to write a single object.

Parameters

writeSink:AbstractChannel<KQueueServerSocketChannel, SocketAddress, SocketAddress>.WriteSink: the WriteSink used.

Exceptions

Exception:: If an I/O error occurs.

enableTcpNoDelayIfSupported	back to summary
private void enableTcpNoDelayIfSupported()

filterOutboundMessage back to summary

filterOutboundMessage	back to summary
protected Object filterOutboundMessage(Object msg) Overrides io.netty5.channel.AbstractChannel.filterOutboundMessage. Doc from io.netty5.channel.AbstractChannel.filterOutboundMessage. Invoked when a new message is added to to the outbound queue of this `AbstractChannel`, so that the `Channel` implementation converts the message to another. (e.g. heap buffer -> direct buffer) Parameters msg:Object the message to filter / convert. Annotations @Override

protected Object filterOutboundMessage(Object msg)

Overrides io.netty5.channel.AbstractChannel.filterOutboundMessage.

Doc from io.netty5.channel.AbstractChannel.filterOutboundMessage.

Invoked when a new message is added to to the outbound queue of this AbstractChannel, so that the Channel implementation converts the message to another. (e.g. heap buffer -> direct buffer)

Parameters

msg:Object: the message to filter / convert.

Annotations

@Override

getExtendedOption back to summary

getExtendedOption	back to summary
protected <T> T getExtendedOption(ChannelOption<T> option) Overrides io.netty5.channel.kqueue.AbstractKQueueChannel.getExtendedOption. Doc from io.netty5.channel.AbstractChannel.getExtendedOption. Override to add support for more `ChannelOption`s. You need to also call `super` after handling the extra options. Parameters <T> the value type. option:ChannelOption<T> the `ChannelOption`. Returns:T the value for the option. Annotations @SuppressWarnings:unchecked @Override

protected <T> T getExtendedOption(ChannelOption<T> option)

Overrides io.netty5.channel.kqueue.AbstractKQueueChannel.getExtendedOption.

Doc from io.netty5.channel.AbstractChannel.getExtendedOption.

Override to add support for more ChannelOptions. You need to also call super after handling the extra options.

Parameters

<T>: the value type.
option:ChannelOption<T>: the ChannelOption.

Returns:T

the value for the option.

Annotations

@SuppressWarnings:unchecked
@Override

getPeerCredentials	back to summary
private PeerCredentials getPeerCredentials()

getReadMode	back to summary
private DomainSocketReadMode getReadMode()

getReceiveBufferSize	back to summary
private int getReceiveBufferSize()

getSendBufferSize	back to summary
private int getSendBufferSize()

getSndLowAt	back to summary
private int getSndLowAt()

getSoLinger	back to summary
private int getSoLinger()

getTrafficClass	back to summary
private int getTrafficClass()

isExtendedOptionSupported back to summary

isExtendedOptionSupported	back to summary
protected boolean isExtendedOptionSupported(ChannelOption<?> option) Overrides io.netty5.channel.kqueue.AbstractKQueueChannel.isExtendedOptionSupported. Doc from io.netty5.channel.AbstractChannel.isExtendedOptionSupported. Override to add support for more `ChannelOption`s. You need to also call `super` after handling the extra options. Parameters option:ChannelOption<?> the `ChannelOption`. Returns:boolean `true` if supported, `false` otherwise. Annotations @Override

protected boolean isExtendedOptionSupported(ChannelOption<?> option)

Overrides io.netty5.channel.kqueue.AbstractKQueueChannel.isExtendedOptionSupported.

Doc from io.netty5.channel.AbstractChannel.isExtendedOptionSupported.

Override to add support for more ChannelOptions. You need to also call super after handling the extra options.

Parameters

option:ChannelOption<?>: the ChannelOption.

Returns:boolean

true if supported, false otherwise.

Annotations

@Override

isKeepAlive	back to summary
private boolean isKeepAlive()

isReuseAddress	back to summary
private boolean isReuseAddress()

isShutdown back to summary

isShutdown	back to summary
public boolean isShutdown(ChannelShutdownDirection direction) Implements io.netty5.channel.Channel.isShutdown. Doc from io.netty5.channel.Channel.isShutdown. Returns `true` if the `ChannelShutdownDirection` of the `Channel` was shutdown before. Annotations @Override

public boolean isShutdown(ChannelShutdownDirection direction)

Implements io.netty5.channel.Channel.isShutdown.

Doc from io.netty5.channel.Channel.isShutdown.

Returns true if the ChannelShutdownDirection of the Channel was shutdown before.

Annotations

@Override

isSupported	back to summary
private boolean isSupported(SocketProtocolFamily protocolFamily, ChannelOption<?> option)

isTcpFastOpenConnect	back to summary
private boolean isTcpFastOpenConnect() Returns `true` if TCP fast open is enabled, `false` otherwise.

isTcpNoDelay	back to summary
private boolean isTcpNoDelay()

isTcpNoPush	back to summary
private boolean isTcpNoPush()

prepareToClose back to summary

prepareToClose	back to summary
protected Future<Executor> prepareToClose() Overrides io.netty5.channel.AbstractChannel.prepareToClose. Doc from io.netty5.channel.AbstractChannel.prepareToClose. Prepares to close the `Channel`. If this method returns an `Executor`, the caller must call the `Executor#execute(Runnable)` method with a task that calls `doClose()` on the returned `Executor`. If this method returns `null`, `doClose()` must be called from the caller thread. (i.e. `EventLoop`) Annotations @Override

protected Future<Executor> prepareToClose()

Overrides io.netty5.channel.AbstractChannel.prepareToClose.

Doc from io.netty5.channel.AbstractChannel.prepareToClose.

Prepares to close the Channel. If this method returns an Executor, the caller must call the Executor#execute(Runnable) method with a task that calls doClose() on the returned Executor. If this method returns null, doClose() must be called from the caller thread. (i.e. EventLoop)

Annotations

@Override

readReady	back to summary
pack-priv int readReady(AbstractChannel<KQueueServerSocketChannel, SocketAddress, SocketAddress>.ReadSink readSink) throws Exception Implements abstract io.netty5.channel.kqueue.AbstractKQueueChannel.readReady. Annotations @Override

readReady

back to summary

pack-priv int readReady(AbstractChannel<KQueueServerSocketChannel, SocketAddress, SocketAddress>.ReadSink readSink) throws Exception

Implements abstract io.netty5.channel.kqueue.AbstractKQueueChannel.readReady.

Annotations

@Override

readReadyBytes	back to summary
private int readReadyBytes(AbstractChannel<KQueueServerSocketChannel, SocketAddress, SocketAddress>.ReadSink readSink) throws Exception

readReadyFd	back to summary
private int readReadyFd(AbstractChannel<KQueueServerSocketChannel, SocketAddress, SocketAddress>.ReadSink readSink) throws Exception

setExtendedOption back to summary

setExtendedOption	back to summary
protected <T> void setExtendedOption(ChannelOption<T> option, T value) Overrides io.netty5.channel.kqueue.AbstractKQueueChannel.setExtendedOption. Doc from io.netty5.channel.AbstractChannel.setExtendedOption. Override to add support for more `ChannelOption`s. You need to also call `super` after handling the extra options. Parameters <T> the value type. option:ChannelOption<T> the `ChannelOption`. Annotations @Override

protected <T> void setExtendedOption(ChannelOption<T> option, T value)

Overrides io.netty5.channel.kqueue.AbstractKQueueChannel.setExtendedOption.

Doc from io.netty5.channel.AbstractChannel.setExtendedOption.

Override to add support for more ChannelOptions. You need to also call super after handling the extra options.

Parameters

<T>: the value type.
option:ChannelOption<T>: the ChannelOption.

Annotations

@Override

setKeepAlive	back to summary
private void setKeepAlive(boolean keepAlive)

setReadMode	back to summary
private void setReadMode(DomainSocketReadMode mode)

setReceiveBufferSize	back to summary
private void setReceiveBufferSize(int receiveBufferSize)

setReuseAddress	back to summary
private void setReuseAddress(boolean reuseAddress)

setSendBufferSize	back to summary
private void setSendBufferSize(int sendBufferSize)

setSndLowAt	back to summary
private void setSndLowAt(int sndLowAt)

setSoLinger	back to summary
private void setSoLinger(int soLinger)

setTcpFastOpenConnect	back to summary
private void setTcpFastOpenConnect(boolean fastOpenConnect) Enables client TCP fast open, if available.

setTcpNoDelay	back to summary
private void setTcpNoDelay(boolean tcpNoDelay)

setTcpNoPush	back to summary
private void setTcpNoPush(boolean tcpNoPush)

setTrafficClass	back to summary
private void setTrafficClass(int trafficClass)

supportedOptions	back to summary
private static Set<ChannelOption<?>> supportedOptions() Hides io.netty5.channel.AbstractChannel.supportedOptions.

supportedOptionsDomainSocket	back to summary
private static Set<ChannelOption<?>> supportedOptionsDomainSocket()

writeBytes back to summary

private void writeBytes(AbstractChannel<KQueueServerSocketChannel, SocketAddress, SocketAddress>.WriteSink writeSink) throws Exception

Write bytes form the given Buffer to the underlying java.nio.channels.Channel.

Parameters

writeSink:AbstractChannel<KQueueServerSocketChannel, SocketAddress, SocketAddress>.WriteSink: the WriteSink used.

writeBytesMultiple back to summary

private long writeBytesMultiple(IovArray array) throws IOException

Write multiple bytes via IovArray.

Parameters

array:IovArray: The array which contains the content to write.

Returns:long

number of written bytes.

Exceptions

IOException:: If an I/O exception occurs during write.

writeBytesMultiple back to summary

private long writeBytesMultiple(ByteBuffer[] nioBuffers, int nioBufferCnt, long expectedWrittenBytes, long maxBytesPerGatheringWrite) throws IOException

Write multiple bytes via ByteBuffer array.

Parameters

nioBuffers:ByteBuffer[]: The buffers to write.
nioBufferCnt:int: The number of buffers to write.
expectedWrittenBytes:long: The number of bytes we expect to write.
maxBytesPerGatheringWrite:long: The maximum number of bytes we should attempt to write.

Returns:long