Module io.netty5.transport.classes.epoll

Package io.netty5.channel.epoll

Class EpollSocketChannel

java.lang.Object

io.netty5.util.DefaultAttributeMap

io.netty5.channel.AbstractChannel<P,SocketAddress,SocketAddress>

io.netty5.channel.epoll.EpollSocketChannel

All Implemented Interfaces:

Channel, ChannelOutboundInvoker, IoHandle, SocketChannel, UnixChannel, AttributeMap, FuturePromiseFactory, Comparable<Channel>

public final class EpollSocketChannel
extends AbstractChannel<P,SocketAddress,SocketAddress>
implements SocketChannel

SocketChannel implementation that uses linux EPOLL Edge-Triggered Mode for maximal performance.

Available options

In addition to the options provided by SocketChannel and UnixChannel, EpollSocketChannel allows the following options in the option map:

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

Nested Class Summary

Nested classes/interfaces inherited from class io.netty5.channel.AbstractChannel

AbstractChannel.DefaultAbstractChannelPipeline

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	active
protected LinuxSocket	socket

Constructor Summary

Constructors

Constructor	Description
EpollSocketChannel(EventLoop eventLoop)
EpollSocketChannel(EventLoop eventLoop, int fd, ProtocolFamily family)
EpollSocketChannel(EventLoop eventLoop, ProtocolFamily protocolFamily)

Method Summary

Modifier and Type	Method	Description
protected void	autoReadCleared()	Is called once AbstractChannel.setAutoRead(boolean) is called with false and AbstractChannel.isAutoRead() was true before.
protected static void	checkResolvable(InetSocketAddress addr)
protected void	clearFlag(int flag)
protected void	doBeginRead()	Schedule a read operation.
protected void	doBind(SocketAddress local)	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 boolean	doConnect0(SocketAddress remote)
protected void	doDisconnect()	Disconnect this Channel from its remote peer
protected boolean	doFinishConnect(SocketAddress requestedRemoteAddress)	Finish a connect request.
protected void	doReadBytes(Buffer buffer)	Read bytes into the given Buffer and return the amount.
protected void	doShutdown(ChannelShutdownDirection direction)	Shutdown one direction of the Channel.
protected void	doWrite(ChannelOutboundBuffer in)	Flush the content of the given buffer to the remote peer.
protected int	doWriteBytes(ChannelOutboundBuffer in, Buffer buf)
protected long	doWriteOrSendBytes(Buffer data, SocketAddress remoteAddress, boolean fastOpen)	Write bytes to the socket, with or without a remote address.
protected void	epollInReady(RecvBufferAllocator.Handle handle, BufferAllocator recvBufferAllocator, boolean receivedRdHup)	Called once EPOLLIN event is ready to be processed
FileDescriptor	fd()	Returns the FileDescriptor that is used by this Channel.
protected boolean	fetchLocalAddress()
protected 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 <T> T	getExtendedOption(ChannelOption<T> option)	Override to add support for more ChannelOptions.
boolean	isActive()	Return true if the Channel is active and so connected.
protected boolean	isExtendedOptionSupported(ChannelOption<?> option)	Override to add support for more ChannelOptions.
boolean	isIpTransparent()	Returns true if IP_TRANSPARENT is enabled, false otherwise.
boolean	isOpen()	Returns true if the Channel is open and may get active later
boolean	isShutdown(ChannelShutdownDirection direction)	Returns true if the ChannelShutdownDirection of the Channel was shutdown before.
protected static boolean	isSoErrorZero(Socket fd)
protected SocketAddress	localAddress0()	Returns the SocketAddress which is bound locally.
protected boolean	maybeMoreDataToRead(RecvBufferAllocator.Handle handle)
protected Buffer	newDirectBuffer(Buffer buf)	Returns an off-heap copy of, and then closes, the given Buffer.
protected Buffer	newDirectBuffer(Resource<?> holder, Buffer buf)	Returns an off-heap copy of the given Buffer, and then closes the holder under the assumption that it owned (or was itself) the buffer.
protected Future<Executor>	prepareToClose()	Prepares to close the Channel.
protected io.netty5.channel.epoll.EpollRegistration	registration()
protected SocketAddress	remoteAddress0()	Return the SocketAddress which the Channel is connected to.
protected <T> void	setExtendedOption(ChannelOption<T> option, T value)	Override to add support for more ChannelOptions.
protected void	setFlag(int flag)
protected void	shutdownInput(boolean rdHup)	Shutdown the input side of the channel.
protected void	writeFlushed()	Write previous flushed messages.

Methods inherited from class io.netty5.channel.AbstractChannel

annotateConnectException, assertEventLoop, bufferAllocator, cacheAddresses, closeForciblyTransport, closeFuture, closeIfClosed, closeTransport, compareTo, deregisterTransport, ensureOpen, equals, executor, finishConnect, fireChannelActiveIfNotActiveBefore, getMaxMessagesPerWrite, getOption, getWriteSpinCount, handleWriteError, hashCode, id, isAllowHalfClosure, isAutoRead, isConnectPending, isOptionSupported, isRegistered, localAddress, metadata, newChannelPipeline, newSupportedIdentityOptionsSet, outboundBuffer, parent, pipeline, readIfIsAutoRead, recvBufAllocHandle, remoteAddress, runAfterTransportAction, safeSetFailure, safeSetSuccess, setBufferAllocator, setOption, shutdownTransport, toString, validate, validateEventLoopGroup, validateFileRegion, writableBytes

Methods inherited from class io.netty5.util.DefaultAttributeMap

attr, hasAttr

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty5.util.AttributeMap

attr, hasAttr

Methods inherited from interface io.netty5.channel.Channel

bind, bufferAllocator, close, closeFuture, connect, connect, deregister, disconnect, executor, flush, getOption, id, isActive, isOpen, isOptionSupported, isWritable, localAddress, metadata, pipeline, read, register, remoteAddress, sendOutboundEvent, setOption, shutdown, writableBytes, write, writeAndFlush

Methods inherited from interface io.netty5.channel.ChannelOutboundInvoker

newFailedFuture, newPromise, newSucceededFuture, newSucceededFuture

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface io.netty5.channel.IoHandle

isRegistered

Methods inherited from interface io.netty5.channel.socket.SocketChannel

parent

Field Detail

socket

protected final LinuxSocket socket

active

protected volatile boolean active

Constructor Detail

EpollSocketChannel

public EpollSocketChannel(EventLoop eventLoop)

EpollSocketChannel

public EpollSocketChannel(EventLoop eventLoop,
                          ProtocolFamily protocolFamily)

EpollSocketChannel

public EpollSocketChannel(EventLoop eventLoop,
                          int fd,
                          ProtocolFamily family)

Method Detail

doWrite

protected void doWrite(ChannelOutboundBuffer in)
                throws Exception

Description copied from class: AbstractChannel

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

Specified by:

doWrite in class AbstractChannel<EpollServerSocketChannel,SocketAddress,SocketAddress>

Throws:

Exception

filterOutboundMessage

protected Object filterOutboundMessage(Object msg)

Description copied from class: AbstractChannel

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

Overrides:

filterOutboundMessage in class AbstractChannel<EpollServerSocketChannel,SocketAddress,SocketAddress>

doShutdown

protected void doShutdown(ChannelShutdownDirection direction)
                   throws Exception

Description copied from class: AbstractChannel

Shutdown one direction of the Channel.

Specified by:

doShutdown in class AbstractChannel<EpollServerSocketChannel,SocketAddress,SocketAddress>

Parameters:

direction - the direction to shutdown.

Throws:

Exception - thrown on error.

isShutdown

public boolean isShutdown(ChannelShutdownDirection direction)

Description copied from interface: Channel

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

Specified by:

isShutdown in interface Channel

epollInReady

protected void epollInReady(RecvBufferAllocator.Handle handle,
                            BufferAllocator recvBufferAllocator,
                            boolean receivedRdHup)

Called once EPOLLIN event is ready to be processed

getExtendedOption

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

Description copied from class: AbstractChannel

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

Type Parameters:

T - the value type.

Parameters:

option - the ChannelOption.

Returns:

the value for the option

setExtendedOption

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

Description copied from class: AbstractChannel

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

Type Parameters:

T - the value type.

Parameters:

option - the ChannelOption.

isExtendedOptionSupported

protected boolean isExtendedOptionSupported(ChannelOption<?> option)

Description copied from class: AbstractChannel

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

Parameters:

option - the ChannelOption.

Returns:

true if supported, false otherwise.

isIpTransparent

public boolean isIpTransparent()

Returns true if IP_TRANSPARENT is enabled, false otherwise.

doConnect0

protected boolean doConnect0(SocketAddress remote)
                      throws Exception

Throws:

Exception

prepareToClose

protected Future<Executor> prepareToClose()

Description copied from class: AbstractChannel

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 AbstractChannel.doClose() on the returned Executor. If this method returns null, AbstractChannel.doClose() must be called from the caller thread. (i.e. EventLoop)

Overrides:

prepareToClose in class AbstractChannel<EpollServerSocketChannel,SocketAddress,SocketAddress>

maybeMoreDataToRead

protected boolean maybeMoreDataToRead(RecvBufferAllocator.Handle handle)

fetchLocalAddress

protected final boolean fetchLocalAddress()

isSoErrorZero

protected static boolean isSoErrorZero(Socket fd)

setFlag

protected final void setFlag(int flag)
                      throws IOException

Throws:

IOException

clearFlag

protected final void clearFlag(int flag)
                        throws IOException

Throws:

IOException

registration

protected final io.netty5.channel.epoll.EpollRegistration registration()

fd

public final FileDescriptor fd()

Description copied from interface: UnixChannel

Returns the FileDescriptor that is used by this Channel.

Specified by:

fd in interface UnixChannel

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

doClose

protected void doClose()
                throws Exception

Description copied from class: AbstractChannel

Close the Channel

Specified by:

doClose in class AbstractChannel<P extends UnixChannel,SocketAddress,SocketAddress>

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<P extends UnixChannel,SocketAddress,SocketAddress>

Throws:

Exception

isOpen

public final boolean isOpen()

Description copied from interface: Channel

Returns true if the Channel is open and may get active later

Specified by:

isOpen in interface Channel

doBeginRead

protected final void doBeginRead()
                          throws Exception

Description copied from class: AbstractChannel

Schedule a read operation.

Specified by:

doBeginRead in class AbstractChannel<P extends UnixChannel,SocketAddress,SocketAddress>

Throws:

Exception

newDirectBuffer

protected final Buffer newDirectBuffer(Buffer buf)

Returns an off-heap copy of, and then closes, the given Buffer.

newDirectBuffer

protected final Buffer newDirectBuffer(Resource<?> holder,
                                       Buffer buf)

Returns an off-heap copy of the given Buffer, and then closes the holder under the assumption that it owned (or was itself) the buffer.

checkResolvable

protected static void checkResolvable(InetSocketAddress addr)

doReadBytes

protected final void doReadBytes(Buffer buffer)
                          throws Exception

Read bytes into the given Buffer and return the amount.

Throws:

Exception

doWriteBytes

protected final int doWriteBytes(ChannelOutboundBuffer in,
                                 Buffer buf)
                          throws Exception

Throws:

Exception

doWriteOrSendBytes

protected final long doWriteOrSendBytes(Buffer data,
                                        SocketAddress remoteAddress,
                                        boolean fastOpen)
                                 throws IOException

Write bytes to the socket, with or without a remote address. Used for datagram and TCP client fast open writes.

Throws:

IOException

shutdownInput

protected final void shutdownInput(boolean rdHup)

Shutdown the input side of the channel.

writeFlushed

protected final void writeFlushed()

Description copied from class: AbstractChannel

Write previous flushed messages.

Overrides:

writeFlushed in class AbstractChannel<P extends UnixChannel,SocketAddress,SocketAddress>

doFinishConnect

protected boolean doFinishConnect(SocketAddress requestedRemoteAddress)
                           throws Exception

Description copied from class: AbstractChannel

Finish a connect request.

Specified by:

doFinishConnect in class AbstractChannel<P extends UnixChannel,SocketAddress,SocketAddress>

Parameters:

requestedRemoteAddress - the remote address of the peer.

Returns:

true if the connect was completed, false if AbstractChannel.finishConnect() will be called later again to try finishing the connect.

Throws:

Exception - thrown on error.

doBind

protected void doBind(SocketAddress local)
               throws Exception

Description copied from class: AbstractChannel

Bind the Channel to the SocketAddress

Specified by:

doBind in class AbstractChannel<P extends UnixChannel,SocketAddress,SocketAddress>

Throws:

Exception

doConnect

protected boolean doConnect(SocketAddress remoteAddress,
                            SocketAddress localAddress)
                     throws Exception

Connect to the remote peer

Specified by:

doConnect in class AbstractChannel<P extends UnixChannel,SocketAddress,SocketAddress>

Parameters:

remoteAddress - the address of the remote peer.

localAddress - the local address of this channel.

Returns:

true if the connect was completed, false if AbstractChannel.finishConnect() will be called later again to try finishing the connect.

Throws:

Exception - thrown on error.

localAddress0

protected final SocketAddress localAddress0()

Description copied from class: AbstractChannel

Returns the SocketAddress which is bound locally.

Specified by:

localAddress0 in class AbstractChannel<P extends UnixChannel,SocketAddress,SocketAddress>

remoteAddress0

protected final SocketAddress remoteAddress0()

Description copied from class: AbstractChannel

Return the SocketAddress which the Channel is connected to.

Specified by:

remoteAddress0 in class AbstractChannel<P extends UnixChannel,SocketAddress,SocketAddress>

autoReadCleared

protected final void autoReadCleared()

Description copied from class: AbstractChannel

Is called once AbstractChannel.setAutoRead(boolean) is called with false and AbstractChannel.isAutoRead() was true before.

Overrides:

autoReadCleared in class AbstractChannel<P extends UnixChannel,SocketAddress,SocketAddress>