Class AbstractEpollChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.epoll.AbstractEpollChannel

All Implemented Interfaces:

Channel, ChannelOutboundInvoker, UnixChannel, AttributeMap, Comparable<Channel>

Direct Known Subclasses:

AbstractEpollServerChannel, AbstractEpollStreamChannel, EpollDatagramChannel, EpollDomainDatagramChannel

abstract class AbstractEpollChannel
extends AbstractChannel
implements UnixChannel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractEpollChannel.AbstractEpollUnsafe

Nested classes/interfaces inherited from class AbstractChannel

AbstractChannel.AbstractUnsafe

Nested classes/interfaces inherited from interface Channel

Channel.Unsafe

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	active
private ChannelPromise	connectPromise	The future of the current connection attempt.
private Future<?>	connectTimeoutFuture
private final EpollIoOps	initial
(package private) boolean	inputClosedSeenErrorOnRead
private SocketAddress	local
private static final ChannelMetadata	METADATA
private EpollIoOps	ops
private IoRegistration	registration
private SocketAddress	remote
private SocketAddress	requestedRemoteAddress
protected final LinuxSocket	socket

Constructor Summary

Constructors

Constructor	Description
AbstractEpollChannel(Channel parent, LinuxSocket fd, boolean active, EpollIoOps initialOps)
AbstractEpollChannel(Channel parent, LinuxSocket fd, SocketAddress remote, EpollIoOps initialOps)

Method Summary

Modifier and Type	Method	Description
protected static void	checkResolvable(InetSocketAddress addr)
(package private) final void	clearEpollIn()
(package private) void	clearFlag(int flag)
abstract EpollChannelConfig	config()	Returns the configuration of this channel.
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
(package private) boolean	doConnect0(SocketAddress remote)
protected void	doDeregister()	Deregister the Channel from its EventLoop.
protected void	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(ChannelPromise promise)	Is called after the Channel is registered with its EventLoop as part of the register process.
protected final int	doWriteBytes(ChannelOutboundBuffer in, ByteBuf buf)
(package private) final long	doWriteOrSendBytes(ByteBuf data, InetSocketAddress remoteAddress, boolean fastOpen)	Write bytes to the socket, with or without a remote address.
final FileDescriptor	fd()	Returns the FileDescriptor that is used by this Channel.
boolean	isActive()	Return true if the Channel is active and so connected.
private static boolean	isAllowHalfClosure(ChannelConfig config)
protected boolean	isCompatible(EventLoop loop)	Return true if the given EventLoop is compatible with this instance.
(package private) boolean	isFlagSet(int flag)
boolean	isOpen()	Returns true if the Channel is open and may get active later
(package private) static boolean	isSoErrorZero(Socket fd)
protected SocketAddress	localAddress0()	Returns the SocketAddress which is bound locally.
ChannelMetadata	metadata()	Return the ChannelMetadata of the Channel which describe the nature of the Channel.
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()	Create a new AbstractChannel.AbstractUnsafe instance which will be used for the life-time of the Channel
protected final IoRegistration	registration()
protected SocketAddress	remoteAddress0()	Return the SocketAddress which the Channel is connected to.
(package private) void	resetCachedAddresses()
protected void	setFlag(int flag)
(package private) final boolean	shouldBreakEpollInReady(ChannelConfig config)
(package private) final void	submitCurrentOps()

Methods inherited from class AbstractChannel

closeFuture, compareTo, doRegister, doShutdownOutput, doWrite, equals, eventLoop, filterOutboundMessage, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, localAddress, maxMessagesPerWrite, newChannelPipeline, newId, parent, pipeline, remoteAddress, toString, unsafe, validateFileRegion, voidPromise

Methods inherited from class DefaultAttributeMap

attr, hasAttr

Methods inherited from class Object

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

Methods inherited from interface AttributeMap

attr, hasAttr

Methods inherited from interface Channel

alloc, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, closeFuture, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, eventLoop, flush, getOption, id, isRegistered, isWritable, localAddress, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, remoteAddress, setOption, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from interface Comparable

compareTo

Field Details

METADATA

private static final ChannelMetadata METADATA

socket

protected final LinuxSocket socket

initial

private final EpollIoOps initial

connectPromise

private ChannelPromise connectPromise

The future of the current connection attempt. If not null, subsequent connection attempts will fail.

connectTimeoutFuture

private Future<?> connectTimeoutFuture

requestedRemoteAddress

private SocketAddress requestedRemoteAddress

local

private volatile SocketAddress local

remote

private volatile SocketAddress remote

registration

private IoRegistration registration

inputClosedSeenErrorOnRead

boolean inputClosedSeenErrorOnRead

ops

private EpollIoOps ops

active

protected volatile boolean active

Constructor Details

AbstractEpollChannel

AbstractEpollChannel(Channel parent,
 LinuxSocket fd,
 boolean active,
 EpollIoOps initialOps)

AbstractEpollChannel

AbstractEpollChannel(Channel parent,
 LinuxSocket fd,
 SocketAddress remote,
 EpollIoOps initialOps)

Method Details

isSoErrorZero

static boolean isSoErrorZero(Socket fd)

setFlag

protected void setFlag(int flag)
                throws IOException

Throws:

IOException

clearFlag

void clearFlag(int flag)
        throws IOException

Throws:

IOException

registration

protected final IoRegistration registration()

isFlagSet

boolean isFlagSet(int flag)

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

config

public abstract EpollChannelConfig config()

Description copied from interface: Channel

Returns the configuration of this channel.

Specified by:

config in interface Channel

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

metadata

public ChannelMetadata metadata()

Description copied from interface: Channel

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

Specified by:

metadata in interface Channel

doClose

protected void doClose()
                throws Exception

Description copied from class: AbstractChannel

Close the Channel

Specified by:

doClose in class AbstractChannel

Throws:

Exception

resetCachedAddresses

void resetCachedAddresses()

doDisconnect

protected void doDisconnect()
                     throws Exception

Description copied from class: AbstractChannel

Disconnect this Channel from its remote peer

Specified by:

doDisconnect in class AbstractChannel

Throws:

Exception

isOpen

public 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

doDeregister

protected void doDeregister()
                     throws Exception

Description copied from class: AbstractChannel

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

Overrides:

doDeregister in class AbstractChannel

Throws:

Exception

isCompatible

protected boolean isCompatible(EventLoop loop)

Description copied from class: AbstractChannel

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

Specified by:

isCompatible in class AbstractChannel

doBeginRead

protected void doBeginRead()
                    throws Exception

Description copied from class: AbstractChannel

Schedule a read operation.

Specified by:

doBeginRead in class AbstractChannel

Throws:

Exception

shouldBreakEpollInReady

final boolean shouldBreakEpollInReady(ChannelConfig config)

isAllowHalfClosure

private static boolean isAllowHalfClosure(ChannelConfig config)

clearEpollIn

final void clearEpollIn()

doRegister

protected void doRegister(ChannelPromise promise)

Description copied from class: AbstractChannel

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

Overrides:

doRegister in class AbstractChannel

Parameters:

promise - ChannelPromise that must be notified once done to continue the registration.

newUnsafe

protected abstract AbstractEpollChannel.AbstractEpollUnsafe newUnsafe()

Description copied from class: AbstractChannel

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

Specified by:

newUnsafe in class AbstractChannel

newDirectBuffer

protected final ByteBuf newDirectBuffer(ByteBuf buf)

Returns an off-heap copy of the specified ByteBuf, and releases the original one.

newDirectBuffer

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

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

checkResolvable

protected static void checkResolvable(InetSocketAddress addr)

doReadBytes

protected final int doReadBytes(ByteBuf byteBuf)
                         throws Exception

Read bytes into the given ByteBuf and return the amount.

Throws:

Exception

doWriteBytes

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

Throws:

Exception

doWriteOrSendBytes

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.

Throws:

IOException

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

Throws:

Exception

doConnect

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

Connect to the remote peer

Throws:

Exception

doConnect0

boolean doConnect0(SocketAddress remote)
            throws Exception

Throws:

Exception

submitCurrentOps

final void submitCurrentOps()

localAddress0

protected SocketAddress localAddress0()

Description copied from class: AbstractChannel

Returns the SocketAddress which is bound locally.

Specified by:

localAddress0 in class AbstractChannel

remoteAddress0

protected SocketAddress remoteAddress0()

Description copied from class: AbstractChannel

Return the SocketAddress which the Channel is connected to.

Specified by:

remoteAddress0 in class AbstractChannel