Modifier and Type	Class and Description
protected abstract class	AbstractEpollChannel.AbstractEpollUnsafe

Modifier and Type	Field and Description
protected volatile boolean	active
private ChannelPromise	connectPromise The future of the current connection attempt.
private Future<?>	connectTimeoutFuture
pack-priv boolean	epollInReadyRunnablePending
protected int	flags
pack-priv boolean	inputClosedSeenErrorOnRead
private volatile SocketAddress	local
private static final ChannelMetadata	METADATA
private volatile SocketAddress	remote
private SocketAddress	requestedRemoteAddress
protected final LinuxSocket	socket

Access	Constructor and Description
pack-priv	AbstractEpollChannel(LinuxSocket fd)
pack-priv	AbstractEpollChannel(Channel parent, LinuxSocket fd, boolean active)
pack-priv	AbstractEpollChannel(Channel parent, LinuxSocket fd, SocketAddress remote)

Method Summary

Modifier and Type	Method and Description
protected static void	checkResolvable(InetSocketAddress addr)
pack-priv final void	clearEpollIn()
pack-priv void	clearFlag(int flag)
public abstract EpollChannelConfig	config() Redeclares io.netty.channel.Channel.config. Returns the configuration of this channel.
protected final void	doBeginRead() Implements abstract io.netty.channel.AbstractChannel.doBeginRead. Schedule a read operation.
protected void	doBind(SocketAddress local) Implements abstract io.netty.channel.AbstractChannel.doBind. Bind the `Channel` to the `SocketAddress`
protected void	doClose() Implements abstract io.netty.channel.AbstractChannel.doClose. Close the `Channel`
protected boolean	doConnect(SocketAddress remoteAddress, SocketAddress localAddress) Connect to the remote peer
pack-priv boolean	doConnect0(SocketAddress remote)
protected void	doDeregister() Overrides io.netty.channel.AbstractChannel.doDeregister. Deregister the `Channel` from its `EventLoop`.
protected void	doDisconnect() Implements abstract io.netty.channel.AbstractChannel.doDisconnect. Disconnect this `Channel` from its remote peer
protected final int	doReadBytes(ByteBuf byteBuf) Read bytes into the given `ByteBuf` and return the amount.
protected void	doRegister() Overrides io.netty.channel.AbstractChannel.doRegister. Is called after the `Channel` is registered with its `EventLoop` as part of the register process.
protected final int	doWriteBytes(ChannelOutboundBuffer in, ByteBuf buf)
pack-priv final long	doWriteOrSendBytes(ByteBuf data, InetSocketAddress remoteAddress, boolean fastOpen) Write bytes to the socket, with or without a remote address.
public final FileDescriptor	fd() Implements io.netty.channel.unix.UnixChannel.fd. Returns the `FileDescriptor` that is used by this `Channel`.
public boolean	isActive() Implements io.netty.channel.Channel.isActive. Return `true` if the `Channel` is active and so connected.
private static boolean	isAllowHalfClosure(ChannelConfig config)
protected boolean	isCompatible(EventLoop loop) Implements abstract io.netty.channel.AbstractChannel.isCompatible. Return `true` if the given `EventLoop` is compatible with this instance.
pack-priv boolean	isFlagSet(int flag)
public boolean	isOpen() Implements io.netty.channel.Channel.isOpen. Returns `true` if the `Channel` is open and may get active later
pack-priv static boolean	isSoErrorZero(Socket fd)
protected SocketAddress	localAddress0() Implements abstract io.netty.channel.AbstractChannel.localAddress0. Returns the `SocketAddress` which is bound locally.
public ChannelMetadata	metadata() Implements io.netty.channel.Channel.metadata. Return the `ChannelMetadata` of the `Channel` which describe the nature of the `Channel`.
private void	modifyEvents()
protected final ByteBuf	newDirectBuffer(ByteBuf buf) Returns an off-heap copy of the specified `ByteBuf`, and releases the original one.
protected final ByteBuf	newDirectBuffer(Object holder, ByteBuf buf) Returns an off-heap copy of the specified `ByteBuf`, and releases the specified holder.
private static ByteBuf	newDirectBuffer0(Object holder, ByteBuf buf, ByteBufAllocator alloc, int capacity)
protected abstract AbstractEpollChannel.AbstractEpollUnsafe	newUnsafe() Implements abstract io.netty.channel.AbstractChannel.newUnsafe. Create a new `AbstractUnsafe` instance which will be used for the life-time of the `Channel`
protected SocketAddress	remoteAddress0() Implements abstract io.netty.channel.AbstractChannel.remoteAddress0. Return the `SocketAddress` which the `Channel` is connected to.
pack-priv void	resetCachedAddresses()
protected void	setFlag(int flag)
pack-priv final boolean	shouldBreakEpollInReady(ChannelConfig config)

Field Detail

active	back to summary
protected volatile boolean active

connectPromise	back to summary
private ChannelPromise connectPromise The future of the current connection attempt. If not null, subsequent connection attempts will fail.

connectTimeoutFuture	back to summary
private Future<?> connectTimeoutFuture

epollInReadyRunnablePending	back to summary
pack-priv boolean epollInReadyRunnablePending

flags	back to summary
protected int flags

inputClosedSeenErrorOnRead	back to summary
pack-priv boolean inputClosedSeenErrorOnRead

local	back to summary
private volatile SocketAddress local

METADATA	back to summary
private static final ChannelMetadata METADATA

remote	back to summary
private volatile SocketAddress remote

requestedRemoteAddress	back to summary
private SocketAddress requestedRemoteAddress

socket	back to summary
protected final LinuxSocket socket

AbstractEpollChannel	back to summary
pack-priv AbstractEpollChannel(LinuxSocket fd)

AbstractEpollChannel	back to summary
pack-priv AbstractEpollChannel(Channel parent, LinuxSocket fd, boolean active)

AbstractEpollChannel	back to summary
pack-priv AbstractEpollChannel(Channel parent, LinuxSocket fd, SocketAddress remote)

Method Detail

checkResolvable	back to summary
protected static void checkResolvable(InetSocketAddress addr)

clearEpollIn	back to summary
pack-priv final void clearEpollIn()

clearFlag	back to summary
pack-priv void clearFlag(int flag) throws IOException

config	back to summary
public abstract EpollChannelConfig config() Redeclares io.netty.channel.Channel.config. Doc from io.netty.channel.Channel.config. Returns the configuration of this channel. Annotations @Override

config

back to summary

public abstract EpollChannelConfig config()

Redeclares io.netty.channel.Channel.config.

Doc from io.netty.channel.Channel.config.

Returns the configuration of this channel.

Annotations

@Override

doBeginRead	back to summary
protected final void doBeginRead() throws Exception Implements abstract io.netty.channel.AbstractChannel.doBeginRead. Doc from io.netty.channel.AbstractChannel.doBeginRead. Schedule a read operation. Annotations @Override

doBeginRead

back to summary

protected final void doBeginRead() throws Exception

Implements abstract io.netty.channel.AbstractChannel.doBeginRead.

Doc from io.netty.channel.AbstractChannel.doBeginRead.

Schedule a read operation.

Annotations

@Override

doBind back to summary

doBind	back to summary
protected void doBind(SocketAddress local) throws Exception Implements abstract io.netty.channel.AbstractChannel.doBind. Doc from io.netty.channel.AbstractChannel.doBind. Bind the `Channel` to the `SocketAddress` Annotations @Override

protected void doBind(SocketAddress local) throws Exception

Implements abstract io.netty.channel.AbstractChannel.doBind.

Doc from io.netty.channel.AbstractChannel.doBind.

Bind the Channel to the SocketAddress

Annotations

@Override

doClose back to summary

doClose	back to summary
protected void doClose() throws Exception Implements abstract io.netty.channel.AbstractChannel.doClose. Doc from io.netty.channel.AbstractChannel.doClose. Close the `Channel` Annotations @Override

protected void doClose() throws Exception

Implements abstract io.netty.channel.AbstractChannel.doClose.

Doc from io.netty.channel.AbstractChannel.doClose.

Close the Channel

Annotations

@Override

doConnect	back to summary
protected boolean doConnect(SocketAddress remoteAddress, SocketAddress localAddress) throws Exception Connect to the remote peer

doConnect0	back to summary
pack-priv boolean doConnect0(SocketAddress remote) throws Exception

doDeregister back to summary

doDeregister	back to summary
protected void doDeregister() throws Exception Overrides io.netty.channel.AbstractChannel.doDeregister. Doc from io.netty.channel.AbstractChannel.doDeregister. Deregister the `Channel` from its `EventLoop`. Sub-classes may override this method Annotations @Override

protected void doDeregister() throws Exception

Overrides io.netty.channel.AbstractChannel.doDeregister.

Doc from io.netty.channel.AbstractChannel.doDeregister.

Deregister the Channel from its EventLoop. Sub-classes may override this method

Annotations

@Override

doDisconnect back to summary

doDisconnect	back to summary
protected void doDisconnect() throws Exception Implements abstract io.netty.channel.AbstractChannel.doDisconnect. Doc from io.netty.channel.AbstractChannel.doDisconnect. Disconnect this `Channel` from its remote peer Annotations @Override

protected void doDisconnect() throws Exception

Implements abstract io.netty.channel.AbstractChannel.doDisconnect.

Doc from io.netty.channel.AbstractChannel.doDisconnect.

Disconnect this Channel from its remote peer

Annotations

@Override

doReadBytes	back to summary
protected final int doReadBytes(ByteBuf byteBuf) throws Exception Read bytes into the given `ByteBuf` and return the amount.

doRegister back to summary

doRegister	back to summary
protected void doRegister() throws Exception Overrides io.netty.channel.AbstractChannel.doRegister. Doc from io.netty.channel.AbstractChannel.doRegister. Is called after the `Channel` is registered with its `EventLoop` as part of the register process. Sub-classes may override this method Annotations @Override

protected void doRegister() throws Exception

Overrides io.netty.channel.AbstractChannel.doRegister.

Doc from io.netty.channel.AbstractChannel.doRegister.

Is called after the Channel is registered with its EventLoop as part of the register process. Sub-classes may override this method

Annotations

@Override

doWriteBytes	back to summary
protected final int doWriteBytes(ChannelOutboundBuffer in, ByteBuf buf) throws Exception

doWriteOrSendBytes	back to summary
pack-priv final long doWriteOrSendBytes(ByteBuf data, InetSocketAddress 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.

fd back to summary

fd	back to summary
public final FileDescriptor fd() Implements io.netty.channel.unix.UnixChannel.fd. Doc from io.netty.channel.unix.UnixChannel.fd. Returns the `FileDescriptor` that is used by this `Channel`. Annotations @Override

public final FileDescriptor fd()

Implements io.netty.channel.unix.UnixChannel.fd.

Doc from io.netty.channel.unix.UnixChannel.fd.

Returns the FileDescriptor that is used by this Channel.

Annotations

@Override

isActive back to summary

isActive	back to summary
public boolean isActive() Implements io.netty.channel.Channel.isActive. Doc from io.netty.channel.Channel.isActive. Return `true` if the `Channel` is active and so connected. Annotations @Override

public boolean isActive()

Implements io.netty.channel.Channel.isActive.

Doc from io.netty.channel.Channel.isActive.

Return true if the Channel is active and so connected.

Annotations

@Override

isAllowHalfClosure	back to summary
private static boolean isAllowHalfClosure(ChannelConfig config)

isCompatible back to summary

isCompatible	back to summary
protected boolean isCompatible(EventLoop loop) Implements abstract io.netty.channel.AbstractChannel.isCompatible. Doc from io.netty.channel.AbstractChannel.isCompatible. Return `true` if the given `EventLoop` is compatible with this instance. Annotations @Override

protected boolean isCompatible(EventLoop loop)

Implements abstract io.netty.channel.AbstractChannel.isCompatible.

Doc from io.netty.channel.AbstractChannel.isCompatible.

Return true if the given EventLoop is compatible with this instance.

Annotations

@Override

isFlagSet	back to summary
pack-priv boolean isFlagSet(int flag)

isOpen back to summary

isOpen	back to summary
public boolean isOpen() Implements io.netty.channel.Channel.isOpen. Doc from io.netty.channel.Channel.isOpen. Returns `true` if the `Channel` is open and may get active later Annotations @Override

public boolean isOpen()

Implements io.netty.channel.Channel.isOpen.

Doc from io.netty.channel.Channel.isOpen.

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

Annotations

@Override

isSoErrorZero	back to summary
pack-priv static boolean isSoErrorZero(Socket fd)

localAddress0 back to summary

localAddress0	back to summary
protected SocketAddress localAddress0() Implements abstract io.netty.channel.AbstractChannel.localAddress0. Doc from io.netty.channel.AbstractChannel.localAddress0. Returns the `SocketAddress` which is bound locally. Annotations @Override

protected SocketAddress localAddress0()

Implements abstract io.netty.channel.AbstractChannel.localAddress0.

Doc from io.netty.channel.AbstractChannel.localAddress0.

Returns the SocketAddress which is bound locally.

Annotations

@Override

metadata back to summary

public ChannelMetadata metadata()

Implements io.netty.channel.Channel.metadata.

Doc from io.netty.channel.Channel.metadata.

Return the ChannelMetadata of the Channel which describe the nature of the Channel.

Annotations

@Override

modifyEvents	back to summary
private void modifyEvents() throws IOException

newDirectBuffer	back to summary
protected final ByteBuf newDirectBuffer(ByteBuf buf) Returns an off-heap copy of the specified `ByteBuf`, and releases the original one.

newDirectBuffer	back to summary
protected final ByteBuf newDirectBuffer(Object holder, ByteBuf buf) Returns an off-heap copy of the specified `ByteBuf`, and releases the specified holder. The caller must ensure that the holder releases the original `ByteBuf` when the holder is released by this method.

newDirectBuffer0	back to summary
private static ByteBuf newDirectBuffer0(Object holder, ByteBuf buf, ByteBufAllocator alloc, int capacity)

newUnsafe back to summary

newUnsafe	back to summary
protected abstract AbstractEpollChannel.AbstractEpollUnsafe newUnsafe() Implements abstract io.netty.channel.AbstractChannel.newUnsafe. Doc from io.netty.channel.AbstractChannel.newUnsafe. Create a new `AbstractUnsafe` instance which will be used for the life-time of the `Channel` Annotations @Override

protected abstract AbstractEpollChannel.AbstractEpollUnsafe newUnsafe()

Implements abstract io.netty.channel.AbstractChannel.newUnsafe.

Doc from io.netty.channel.AbstractChannel.newUnsafe.

Create a new AbstractUnsafe instance which will be used for the life-time of the Channel

Annotations

@Override

remoteAddress0 back to summary

remoteAddress0	back to summary
protected SocketAddress remoteAddress0() Implements abstract io.netty.channel.AbstractChannel.remoteAddress0. Doc from io.netty.channel.AbstractChannel.remoteAddress0. Return the `SocketAddress` which the `Channel` is connected to. Annotations @Override

protected SocketAddress remoteAddress0()

Implements abstract io.netty.channel.AbstractChannel.remoteAddress0.

Doc from io.netty.channel.AbstractChannel.remoteAddress0.

Return the SocketAddress which the Channel is connected to.

Annotations

@Override

resetCachedAddresses	back to summary
pack-priv void resetCachedAddresses()

setFlag	back to summary
protected void setFlag(int flag) throws IOException

shouldBreakEpollInReady	back to summary
pack-priv final boolean shouldBreakEpollInReady(ChannelConfig config)

io.netty.channel.epoll back to summary

protected abstract Class AbstractEpollChannel.AbstractEpollUnsafe

Class Inheritance

extends AbstractUnsafe

java.lang.Object
io.netty.channel.AbstractChannel.AbstractUnsafe
io.netty.channel.epoll.AbstractEpollChannel.AbstractEpollUnsafe

Known Direct Subclasses

io.netty.channel.epoll.AbstractEpollServerChannel.EpollServerSocketUnsafe, io.netty.channel.epoll.AbstractEpollStreamChannel.EpollStreamUnsafe, io.netty.channel.epoll.EpollDatagramChannel.EpollDatagramChannelUnsafe, io.netty.channel.epoll.EpollDomainDatagramChannel.EpollDomainDatagramChannelUnsafe

Field Summary

Modifier and Type	Field and Description
private EpollRecvByteAllocatorHandle	allocHandle Deprecated as a consequence of `EpollRecvByteAllocatorHandle` being deprecated.
private final Runnable	epollInReadyRunnable
pack-priv boolean	maybeMoreDataToRead
pack-priv boolean	readPending

Constructor Summary

Access	Constructor and Description
protected	AbstractEpollUnsafe()

Method Summary

Modifier and Type	Method and Description
protected final void	clearEpollIn0()
private void	clearEpollRdHup() Clear the `Native#EPOLLRDHUP` flag from EPOLL, and close on failure.
public void	connect(final SocketAddress remoteAddress, final SocketAddress localAddress, final ChannelPromise promise) Implements io.netty.channel.Channel.Unsafe.connect. Connect the `Channel` of the given `ChannelFuture` with the given remote `SocketAddress`.
private boolean	doFinishConnect() Finish the connect
pack-priv final void	epollInBefore()
pack-priv final void	epollInFinally(ChannelConfig config)
pack-priv abstract void	epollInReady() Called once EPOLLIN event is ready to be processed
pack-priv final void	epollOutReady() Called once a EPOLLOUT event is ready to be processed
pack-priv final void	epollRdHupReady() Called once EPOLLRDHUP event is ready to be processed
pack-priv final void	executeEpollInReadyRunnable(ChannelConfig config)
private void	finishConnect()
private void	fireEventAndClose(Object evt)
protected final void	flush0() Overrides io.netty.channel.AbstractChannel.AbstractUnsafe.flush0.
private void	fulfillConnectPromise(ChannelPromise promise, boolean wasActive)
private void	fulfillConnectPromise(ChannelPromise promise, Throwable cause)
pack-priv EpollRecvByteAllocatorHandle	newEpollHandle(RecvByteBufAllocator.ExtendedHandle The handle to wrap with EPOLL specific logic. handle) Deprecated as a consequence of `RecvByteBufAllocator.ExtendedHandle` and `EpollRecvByteAllocatorHandle` being deprecated. Create a new `EpollRecvByteAllocatorHandle` instance.
public EpollRecvByteAllocatorHandle	recvBufAllocHandle() Overrides io.netty.channel.AbstractChannel.AbstractUnsafe.recvBufAllocHandle. Implements io.netty.channel.Channel.Unsafe.recvBufAllocHandle. Deprecated as a consequence of `EpollRecvByteAllocatorHandle` being deprecated. Return the assigned `RecvByteBufAllocator.Handle` which will be used to allocate `ByteBuf`'s when receiving data.
pack-priv void	shutdownInput(boolean rdHup) Shutdown the input side of the channel.

Field Detail

allocHandle	back to summary
private EpollRecvByteAllocatorHandle allocHandle Deprecated as a consequence of `EpollRecvByteAllocatorHandle` being deprecated. See corresponding docs for further information.

epollInReadyRunnable	back to summary
private final Runnable epollInReadyRunnable

maybeMoreDataToRead	back to summary
pack-priv boolean maybeMoreDataToRead

readPending	back to summary
pack-priv boolean readPending

Constructor Detail

AbstractEpollUnsafe	back to summary
protected AbstractEpollUnsafe()

Method Detail

clearEpollIn0	back to summary
protected final void clearEpollIn0()

clearEpollRdHup	back to summary
private void clearEpollRdHup() Clear the `Native#EPOLLRDHUP` flag from EPOLL, and close on failure.

connect back to summary

public void connect(final SocketAddress remoteAddress, final SocketAddress localAddress, final ChannelPromise promise)

Implements io.netty.channel.Channel.Unsafe.connect.

Doc from io.netty.channel.Channel.Unsafe.connect.

Connect the Channel of the given ChannelFuture with the given remote SocketAddress. If a specific local SocketAddress should be used it need to be given as argument. Otherwise just pass null to it. The ChannelPromise will get notified once the connect operation was complete.

Annotations

@Override

doFinishConnect	back to summary
private boolean doFinishConnect() throws Exception Finish the connect

epollInBefore	back to summary
pack-priv final void epollInBefore()

epollInFinally	back to summary
pack-priv final void epollInFinally(ChannelConfig config)

epollInReady	back to summary
pack-priv abstract void epollInReady() Called once EPOLLIN event is ready to be processed

epollOutReady	back to summary
pack-priv final void epollOutReady() Called once a EPOLLOUT event is ready to be processed

epollRdHupReady	back to summary
pack-priv final void epollRdHupReady() Called once EPOLLRDHUP event is ready to be processed

executeEpollInReadyRunnable	back to summary
pack-priv final void executeEpollInReadyRunnable(ChannelConfig config)

finishConnect	back to summary
private void finishConnect()

fireEventAndClose	back to summary
private void fireEventAndClose(Object evt)

flush0

back to summary

protected final void flush0()

Overrides io.netty.channel.AbstractChannel.AbstractUnsafe.flush0.

Annotations

@Override

fulfillConnectPromise	back to summary
private void fulfillConnectPromise(ChannelPromise promise, boolean wasActive)

fulfillConnectPromise	back to summary
private void fulfillConnectPromise(ChannelPromise promise, Throwable cause)

newEpollHandle back to summary

pack-priv EpollRecvByteAllocatorHandle newEpollHandle(RecvByteBufAllocator.ExtendedHandle handle)

Deprecated

as a consequence of RecvByteBufAllocator.ExtendedHandle and EpollRecvByteAllocatorHandle being deprecated. See corresponding docs for further information.

Create a new EpollRecvByteAllocatorHandle instance.

Parameters

handle:RecvByteBufAllocator.ExtendedHandle: The handle to wrap with EPOLL specific logic.

recvBufAllocHandle back to summary

public EpollRecvByteAllocatorHandle recvBufAllocHandle()

Overrides io.netty.channel.AbstractChannel.AbstractUnsafe.recvBufAllocHandle.

Implements io.netty.channel.Channel.Unsafe.recvBufAllocHandle.

Doc from io.netty.channel.Channel.Unsafe.recvBufAllocHandle.

Deprecated

as a consequence of EpollRecvByteAllocatorHandle being deprecated. See corresponding docs for further information.

Return the assigned RecvByteBufAllocator.Handle which will be used to allocate ByteBuf's when receiving data.

Annotations

@Override

shutdownInput	back to summary
pack-priv void shutdownInput(boolean rdHup) Shutdown the input side of the channel.

pack-priv abstract Class AbstractEpollChannel

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected abstract Class AbstractEpollChannel.AbstractEpollUnsafe

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail