Netty 5.0.0.Alpha5 · io.netty5.channel.epoll.EpollSocketChannel

`ChannelOption`	`INET`	`INET6`	`UNIX`
`IntegerUnixChannelOption`	X	X	X
`RawUnixChannelOption`	X	X	X
`EpollChannelOption#TCP_CORK`	X	X	-
`EpollChannelOption#TCP_NOTSENT_LOWAT`	X	X	-
`EpollChannelOption#TCP_KEEPCNT`	X	X	-
`EpollChannelOption#TCP_KEEPIDLE`	X	X	-
`EpollChannelOption#TCP_KEEPINTVL`	X	X	-
`EpollChannelOption#TCP_MD5SIG`	X	X	-
`EpollChannelOption#TCP_QUICKACK`	X	X	-
`EpollChannelOption#TCP_INFO`	X	X	-
`ChannelOption#TCP_FASTOPEN_CONNECT`	X	X	-
`EpollChannelOption#IP_TRANSPARENT`	X	X	-
`EpollChannelOption#SO_BUSY_POLL`	X	X	-
`UnixChannelOption#SO_PEERCRED`			X
`UnixChannelOption#DOMAIN_SOCKET_READ_MODE`			X

Modifier and Type	Class and Description
private class	EpollSocketChannel.EpollSocketWritableByteChannel

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
private volatile Collection<InetAddress>	tcpMd5SigAddresses

Access	Constructor and Description
public	EpollSocketChannel(EventLoop eventLoop)
public	EpollSocketChannel(EventLoop eventLoop, ProtocolFamily protocolFamily)
public	EpollSocketChannel(EventLoop eventLoop, int fd, ProtocolFamily family)
private	EpollSocketChannel(EventLoop eventLoop, LinuxSocket socket)
pack-priv	EpollSocketChannel(EpollServerSocketChannel parent, EventLoop eventLoop, LinuxSocket fd, SocketAddress remoteAddress)

Method Summary

Modifier and Type	Method and Description
protected boolean	doConnect0(SocketAddress remote, Buffer initialData) Overrides io.netty5.channel.epoll.AbstractEpollChannel.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	Returns: if we should continue with writing more messages. doWriteMultiple(AbstractChannel<EpollServerSocketChannel, SocketAddress, SocketAddress>.WriteSink the `WriteSink` used to track write results. writeSink) Attempt to write multiple `Buffer` objects.
protected void	doWriteNow(AbstractChannel<EpollServerSocketChannel, 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	Returns: if we should continue with writing more messages. doWriteSingle(AbstractChannel<EpollServerSocketChannel, SocketAddress, SocketAddress>.WriteSink the `WriteSink` used to track write results. writeSink) Attempt to write a single object.
private AbstractEpollChannel.ReadState	epollInReadFd(AbstractChannel<EpollServerSocketChannel, SocketAddress, SocketAddress>.ReadSink readSink)
protected AbstractEpollChannel.ReadState	epollInReady(AbstractChannel<EpollServerSocketChannel, SocketAddress, SocketAddress>.ReadSink readSink) Implements abstract io.netty5.channel.epoll.AbstractEpollChannel.epollInReady. Called once EPOLLIN event is ready to be processed
private AbstractEpollChannel.ReadState	epollInReadyBytes(AbstractChannel<EpollServerSocketChannel, SocketAddress, SocketAddress>.ReadSink readSink)
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.epoll.AbstractEpollChannel.getExtendedOption. Override to add support for more `ChannelOption`s.
private PeerCredentials	getPeerCredentials()
private DomainSocketReadMode	getReadMode()
private int	getReceiveBufferSize()
private int	getSendBufferSize()
private int	getSoBusyPoll() Get the `SO_BUSY_POLL` option on the socket.
private int	getSoLinger()
private EpollTcpInfo	getTcpInfo() Updates and returns the `TCP_INFO` for the current socket.
private int	getTcpKeepCnt() Get the `TCP_KEEPCNT` option on the socket.
private int	getTcpKeepIdle() Get the `TCP_KEEPIDLE` option on the socket.
private int	getTcpKeepIntvl() Get the `TCP_KEEPINTVL` option on the socket.
private long	Returns: value is a uint32_t getTcpNotSentLowAt() Get the `TCP_NOTSENT_LOWAT` option on the socket.
private int	getTcpUserTimeout() Get the `TCP_USER_TIMEOUT` option on the socket.
private int	getTrafficClass()
protected boolean	isExtendedOptionSupported(ChannelOption<?> the `ChannelOption`. option) Overrides io.netty5.channel.epoll.AbstractEpollChannel.isExtendedOptionSupported. Override to add support for more `ChannelOption`s.
public boolean	isIpTransparent() Returns `true` if IP_TRANSPARENT is enabled, `false` otherwise.
private boolean	isKeepAlive()
private static boolean	isOptionSupported(SocketProtocolFamily family, ChannelOption<?> option)
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	isTcpCork() Get the `TCP_CORK` option on the socket.
private boolean	isTcpFastOpenConnect() Returns `true` if TCP fast open is enabled, `false` otherwise.
private boolean	isTcpNoDelay()
private boolean	isTcpQuickAck() Returns `true` if TCP_QUICKACK is enabled, `false` otherwise.
private static WriteHandleFactory	newWriteHandleFactory()
protected Future<Executor>	prepareToClose() Overrides io.netty5.channel.AbstractChannel.prepareToClose. Prepares to close the `Channel`.
protected <T> void	setExtendedOption(ChannelOption<T> the `ChannelOption`. option, T value) Overrides io.netty5.channel.epoll.AbstractEpollChannel.setExtendedOption. Override to add support for more `ChannelOption`s.
private void	setIpTransparent(boolean transparent) If `true` is used IP_TRANSPARENT is enabled, `false` for disable it.
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	setSoBusyPoll(int loopMicros) Set the `SO_BUSY_POLL` option on the socket.
private void	setSoLinger(int soLinger)
private void	setTcpCork(boolean tcpCork) Set the `TCP_CORK` option on the socket.
private void	setTcpFastOpenConnect(boolean fastOpenConnect) Enables client TCP fast open.
private void	setTcpKeepCnt(int probes) Set the `TCP_KEEPCNT` option on the socket.
private void	setTcpKeepIdle(int seconds) Set the `TCP_KEEPIDLE` option on the socket.
private void	setTcpKeepIntvl(int seconds) Set the `TCP_KEEPINTVL` option on the socket.
private void	setTcpMd5Sig(Map<InetAddress, byte[]> keys) Set the `TCP_MD5SIG` option on the socket.
private void	setTcpNoDelay(boolean tcpNoDelay)
private void	setTcpNotSentLowAt(long is a uint32_t tcpNotSentLowAt) Set the `TCP_NOTSENT_LOWAT` option on the socket.
private void	setTcpQuickAck(boolean quickAck) Set the `TCP_QUICKACK` option on the socket.
private void	setTcpUserTimeout(int milliseconds) Set the `TCP_USER_TIMEOUT` option on the socket.
private void	setTrafficClass(int trafficClass)
private static Set<ChannelOption<?>>	supportedOptions() Hides io.netty5.channel.AbstractChannel.supportedOptions.
private static Set<ChannelOption<?>>	supportedOptionsDomainSocket()
private void	Returns: if we should continue with writing more messages. writeBytes(AbstractChannel<EpollServerSocketChannel, SocketAddress, SocketAddress>.WriteSink the `WriteSink` used to track write results. writeSink) Write bytes form the given `Buffer` to the underlying `java.nio.channels.Channel`.
private long	Returns: if we should continue with writing more messages. writeBytesMultiple(IovArray The array which contains the content to write. array) Write multiple bytes via `IovArray`.
private long	Returns: write result. 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	Returns: if we should continue with writing more messages. writeDefaultFileRegion(AbstractChannel<EpollServerSocketChannel, SocketAddress, SocketAddress>.WriteSink the `WriteSink` used to track write results. writeSink) Write a `DefaultFileRegion`
private void	Returns: if we should continue with writing more messages. writeFileRegion(AbstractChannel<EpollServerSocketChannel, SocketAddress, SocketAddress>.WriteSink the `WriteSink` used to track write results. writeSink) Write a `FileRegion`

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

tcpMd5SigAddresses	back to summary
private volatile Collection<InetAddress> tcpMd5SigAddresses

EpollSocketChannel	back to summary
public EpollSocketChannel(EventLoop eventLoop)

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

EpollSocketChannel	back to summary
public EpollSocketChannel(EventLoop eventLoop, int fd, ProtocolFamily family)

EpollSocketChannel	back to summary
private EpollSocketChannel(EventLoop eventLoop, LinuxSocket socket)

EpollSocketChannel	back to summary
pack-priv EpollSocketChannel(EpollServerSocketChannel parent, EventLoop eventLoop, LinuxSocket fd, SocketAddress remoteAddress)

Method Detail

doConnect0	back to summary
protected boolean doConnect0(SocketAddress remote, Buffer initialData) throws Exception Overrides io.netty5.channel.epoll.AbstractEpollChannel.doConnect0. Annotations @Override

doConnect0

back to summary

protected boolean doConnect0(SocketAddress remote, Buffer initialData) throws Exception

Overrides io.netty5.channel.epoll.AbstractEpollChannel.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<EpollServerSocketChannel, SocketAddress, SocketAddress>.WriteSink writeSink) throws Exception Attempt to write multiple `Buffer` objects. Parameters writeSink:AbstractChannel<EpollServerSocketChannel, SocketAddress, SocketAddress>.WriteSink the `WriteSink` used to track write results. Returns:void if we should continue with writing more messages. Exceptions Exception: If an I/O error occurs.

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

Attempt to write multiple Buffer objects.

Parameters

writeSink:AbstractChannel<EpollServerSocketChannel, SocketAddress, SocketAddress>.WriteSink: the WriteSink used to track write results.

Returns:void

if we should continue with writing more messages.

Exceptions

Exception:: If an I/O error occurs.

doWriteNow back to summary

doWriteNow	back to summary
protected void doWriteNow(AbstractChannel<EpollServerSocketChannel, 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<EpollServerSocketChannel, 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<EpollServerSocketChannel, 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<EpollServerSocketChannel, 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<EpollServerSocketChannel, SocketAddress, SocketAddress>.WriteSink writeSink) throws Exception Attempt to write a single object. Parameters writeSink:AbstractChannel<EpollServerSocketChannel, SocketAddress, SocketAddress>.WriteSink the `WriteSink` used to track write results. Returns:void if we should continue with writing more messages. Exceptions Exception: If an I/O error occurs.

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

Attempt to write a single object.

Parameters

writeSink:AbstractChannel<EpollServerSocketChannel, SocketAddress, SocketAddress>.WriteSink: the WriteSink used to track write results.

Returns:void

if we should continue with writing more messages.

Exceptions

Exception:: If an I/O error occurs.

epollInReadFd	back to summary
private AbstractEpollChannel.ReadState epollInReadFd(AbstractChannel<EpollServerSocketChannel, SocketAddress, SocketAddress>.ReadSink readSink) throws Exception

epollInReady	back to summary
protected AbstractEpollChannel.ReadState epollInReady(AbstractChannel<EpollServerSocketChannel, SocketAddress, SocketAddress>.ReadSink readSink) throws Exception Implements abstract io.netty5.channel.epoll.AbstractEpollChannel.epollInReady. Doc from io.netty5.channel.epoll.AbstractEpollChannel.epollInReady. Called once EPOLLIN event is ready to be processed Annotations @Override

epollInReady

back to summary

protected AbstractEpollChannel.ReadState epollInReady(AbstractChannel<EpollServerSocketChannel, SocketAddress, SocketAddress>.ReadSink readSink) throws Exception

Implements abstract io.netty5.channel.epoll.AbstractEpollChannel.epollInReady.

Doc from io.netty5.channel.epoll.AbstractEpollChannel.epollInReady.

Called once EPOLLIN event is ready to be processed

Annotations

@Override

epollInReadyBytes	back to summary
private AbstractEpollChannel.ReadState epollInReadyBytes(AbstractChannel<EpollServerSocketChannel, SocketAddress, SocketAddress>.ReadSink readSink) throws Exception

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.epoll.AbstractEpollChannel.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.epoll.AbstractEpollChannel.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()

getSoBusyPoll	back to summary
private int getSoBusyPoll() Get the `SO_BUSY_POLL` option on the socket. See `man 7 tcp` for more details.

getSoLinger	back to summary
private int getSoLinger()

getTcpInfo	back to summary
private EpollTcpInfo getTcpInfo() Updates and returns the `TCP_INFO` for the current socket. See man 7 tcp.

getTcpKeepCnt	back to summary
private int getTcpKeepCnt() Get the `TCP_KEEPCNT` option on the socket. See `man 7 tcp` for more details.

getTcpKeepIdle	back to summary
private int getTcpKeepIdle() Get the `TCP_KEEPIDLE` option on the socket. See `man 7 tcp` for more details.

getTcpKeepIntvl	back to summary
private int getTcpKeepIntvl() Get the `TCP_KEEPINTVL` option on the socket. See `man 7 tcp` for more details.

getTcpNotSentLowAt back to summary

getTcpNotSentLowAt	back to summary
private long getTcpNotSentLowAt() Get the `TCP_NOTSENT_LOWAT` option on the socket. See `man 7 tcp` for more details. Returns:long value is a uint32_t

private long getTcpNotSentLowAt()

Get the TCP_NOTSENT_LOWAT option on the socket. See man 7 tcp for more details.

Returns:long: value is a uint32_t

getTcpUserTimeout	back to summary
private int getTcpUserTimeout() Get the `TCP_USER_TIMEOUT` option on the socket. See `man 7 tcp` for more details.

getTrafficClass	back to summary
private int getTrafficClass()

isExtendedOptionSupported back to summary

isExtendedOptionSupported	back to summary
protected boolean isExtendedOptionSupported(ChannelOption<?> option) Overrides io.netty5.channel.epoll.AbstractEpollChannel.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.epoll.AbstractEpollChannel.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

isIpTransparent	back to summary
public boolean isIpTransparent() Returns `true` if IP_TRANSPARENT is enabled, `false` otherwise.

isKeepAlive	back to summary
private boolean isKeepAlive()

isOptionSupported	back to summary
private static boolean isOptionSupported(SocketProtocolFamily family, ChannelOption<?> option)

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

isTcpCork	back to summary
private boolean isTcpCork() Get the `TCP_CORK` option on the socket. See `man 7 tcp` for more details.

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

isTcpNoDelay	back to summary
private boolean isTcpNoDelay()

isTcpQuickAck	back to summary
private boolean isTcpQuickAck() Returns `true` if TCP_QUICKACK is enabled, `false` otherwise.

newWriteHandleFactory	back to summary
private static WriteHandleFactory newWriteHandleFactory()

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

setExtendedOption back to summary

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

Overrides io.netty5.channel.epoll.AbstractEpollChannel.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

@SuppressWarnings:unchecked
@Override

setIpTransparent	back to summary
private void setIpTransparent(boolean transparent) If `true` is used IP_TRANSPARENT is enabled, `false` for disable it. Default is disabled.

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)

setSoBusyPoll	back to summary
private void setSoBusyPoll(int loopMicros) Set the `SO_BUSY_POLL` option on the socket. See `man 7 tcp` for more details.

setSoLinger	back to summary
private void setSoLinger(int soLinger)

setTcpCork	back to summary
private void setTcpCork(boolean tcpCork) Set the `TCP_CORK` option on the socket. See `man 7 tcp` for more details.

setTcpFastOpenConnect	back to summary
private void setTcpFastOpenConnect(boolean fastOpenConnect) Enables client TCP fast open. `TCP_FASTOPEN_CONNECT` normally requires Linux kernel 4.11 or later, so instead we use the traditional fast open client socket mechanics that work with kernel 3.6 and later. See this LWN article for more info.

setTcpKeepCnt	back to summary
private void setTcpKeepCnt(int probes) Set the `TCP_KEEPCNT` option on the socket. See `man 7 tcp` for more details.

setTcpKeepIdle	back to summary
private void setTcpKeepIdle(int seconds) Set the `TCP_KEEPIDLE` option on the socket. See `man 7 tcp` for more details.

setTcpKeepIntvl	back to summary
private void setTcpKeepIntvl(int seconds) Set the `TCP_KEEPINTVL` option on the socket. See `man 7 tcp` for more details.

setTcpMd5Sig	back to summary
private void setTcpMd5Sig(Map<InetAddress, byte[]> keys) Set the `TCP_MD5SIG` option on the socket. See `linux/tcp.h` for more details. Keys can only be set on, not read to prevent a potential leak, as they are confidential. Allowing them being read would mean anyone with access to the channel could get them.

setTcpNoDelay	back to summary
private void setTcpNoDelay(boolean tcpNoDelay)

setTcpNotSentLowAt back to summary

private void setTcpNotSentLowAt(long tcpNotSentLowAt)

Set the TCP_NOTSENT_LOWAT option on the socket. See man 7 tcp for more details.

Parameters

tcpNotSentLowAt:long: is a uint32_t

setTcpQuickAck	back to summary
private void setTcpQuickAck(boolean quickAck) Set the `TCP_QUICKACK` option on the socket. See TCP_QUICKACK for more details.

setTcpUserTimeout	back to summary
private void setTcpUserTimeout(int milliseconds) Set the `TCP_USER_TIMEOUT` option on the socket. See `man 7 tcp` for more details.

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<EpollServerSocketChannel, SocketAddress, SocketAddress>.WriteSink writeSink) throws Exception

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

Parameters

writeSink:AbstractChannel<EpollServerSocketChannel, SocketAddress, SocketAddress>.WriteSink: the WriteSink used to track write results.

Returns:void

if we should continue with writing more messages.

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

if we should continue with writing more messages.

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

write result.

Exceptions

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

writeDefaultFileRegion back to summary

private void writeDefaultFileRegion(AbstractChannel<EpollServerSocketChannel, SocketAddress, SocketAddress>.WriteSink writeSink) throws Exception

Write a DefaultFileRegion

Parameters

writeSink:AbstractChannel<EpollServerSocketChannel, SocketAddress, SocketAddress>.WriteSink: the WriteSink used to track write results.

Returns:void

if we should continue with writing more messages.

writeFileRegion back to summary

private void writeFileRegion(AbstractChannel<EpollServerSocketChannel, SocketAddress, SocketAddress>.WriteSink writeSink) throws Exception

Write a FileRegion

Parameters

writeSink:AbstractChannel<EpollServerSocketChannel, SocketAddress, SocketAddress>.WriteSink: the WriteSink used to track write results.

Returns:void

if we should continue with writing more messages.

Modifier and Type	Method and Description
protected BufferAllocator	alloc() Implements abstract io.netty5.channel.unix.SocketWritableByteChannel.alloc.
protected int	write(final ByteBuffer buf, final int pos, final int limit) Overrides io.netty5.channel.unix.SocketWritableByteChannel.write.

public final Class EpollSocketChannel

Available options

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class EpollSocketChannel.EpollSocketWritableByteChannel

Constructor Summary

Method Summary

Constructor Detail

Method Detail