io.netty.channel.epoll

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, java.lang.Comparable<Channel>

Direct Known Subclasses:

AbstractEpollServerChannel, AbstractEpollStreamChannel, EpollDatagramChannel

abstract class AbstractEpollChannel
extends AbstractChannel
implements UnixChannel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractEpollChannel.AbstractEpollUnsafe

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

AbstractChannel.AbstractUnsafe

Nested classes/interfaces inherited from interface io.netty.channel.Channel

Channel.Unsafe

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	active
(package private) boolean	epollInReadyRunnablePending
protected int	flags
(package private) boolean	inputClosedSeenErrorOnRead
private static ChannelMetadata	METADATA
private int	readFlag
(package private) LinuxSocket	socket

Constructor Summary

Constructors

Constructor and Description
AbstractEpollChannel(Channel parent, LinuxSocket fd, int flag, boolean active)
AbstractEpollChannel(LinuxSocket fd, int flag)

Method Summary

Modifier and Type	Method and Description
protected static void	checkResolvable(java.net.InetSocketAddress addr)
(package private) 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	doClose() Close the Channel
protected void	doDeregister() Deregister the Channel from its EventLoop.
protected void	doDisconnect() Disconnect this Channel from its remote peer
protected int	doReadBytes(ByteBuf byteBuf) Read bytes into the given ByteBuf and return the amount.
protected void	doRegister() Is called after the Channel is registered with its EventLoop as part of the register process.
protected int	doWriteBytes(ByteBuf buf, int writeSpinCount)
FileDescriptor	fd() Returns the FileDescriptor that is used by this Channel.
boolean	isActive() Return true if the Channel is active and so connected.
(package private) 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)
ChannelMetadata	metadata() Return the ChannelMetadata of the Channel which describe the nature of the Channel.
private void	modifyEvents()
protected ByteBuf	newDirectBuffer(ByteBuf buf) Returns an off-heap copy of the specified ByteBuf, and releases the original one.
protected ByteBuf	newDirectBuffer(java.lang.Object holder, ByteBuf buf) Returns an off-heap copy of the specified ByteBuf, and releases the specified holder.
private static ByteBuf	newDirectBuffer0(java.lang.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
(package private) void	setFlag(int flag)
(package private) boolean	shouldBreakEpollInReady(ChannelConfig config)

Methods inherited from class io.netty.channel.AbstractChannel

alloc, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, doBind, doWrite, equals, eventLoop, filterOutboundMessage, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, localAddress, localAddress0, newChannelPipeline, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, remoteAddress, remoteAddress0, toString, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from class io.netty.util.DefaultAttributeMap

attr, hasAttr

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.Channel

alloc, bytesBeforeUnwritable, bytesBeforeWritable, closeFuture, eventLoop, flush, id, isRegistered, isWritable, localAddress, parent, pipeline, read, remoteAddress, unsafe

Methods inherited from interface io.netty.util.AttributeMap

attr, hasAttr

Methods inherited from interface io.netty.channel.ChannelOutboundInvoker

bind, bind, close, close, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

METADATA

private static final ChannelMetadata METADATA

readFlag

private final int readFlag

socket

final LinuxSocket socket

flags

protected int flags

inputClosedSeenErrorOnRead

boolean inputClosedSeenErrorOnRead

epollInReadyRunnablePending

boolean epollInReadyRunnablePending

active

protected volatile boolean active

Constructor Detail

AbstractEpollChannel

AbstractEpollChannel(LinuxSocket fd,
                     int flag)

AbstractEpollChannel

AbstractEpollChannel(Channel parent,
                     LinuxSocket fd,
                     int flag,
                     boolean active)

Method Detail

isSoErrorZero

static boolean isSoErrorZero(Socket fd)

setFlag

void setFlag(int flag)
      throws java.io.IOException

Throws:

java.io.IOException

clearFlag

void clearFlag(int flag)
        throws java.io.IOException

Throws:

java.io.IOException

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 java.lang.Exception

Description copied from class: AbstractChannel

Close the Channel

Specified by:

doClose in class AbstractChannel

Throws:

java.lang.Exception

doDisconnect

protected void doDisconnect()
                     throws java.lang.Exception

Description copied from class: AbstractChannel

Disconnect this Channel from its remote peer

Specified by:

doDisconnect in class AbstractChannel

Throws:

java.lang.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

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 java.lang.Exception

Description copied from class: AbstractChannel

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

Overrides:

doDeregister in class AbstractChannel

Throws:

java.lang.Exception

doBeginRead

protected final void doBeginRead()
                          throws java.lang.Exception

Description copied from class: AbstractChannel

Schedule a read operation.

Specified by:

doBeginRead in class AbstractChannel

Throws:

java.lang.Exception

shouldBreakEpollInReady

final boolean shouldBreakEpollInReady(ChannelConfig config)

isAllowHalfClosure

final boolean isAllowHalfClosure(ChannelConfig config)

clearEpollIn

final void clearEpollIn()

modifyEvents

private void modifyEvents()
                   throws java.io.IOException

Throws:

java.io.IOException

doRegister

protected void doRegister()
                   throws java.lang.Exception

Description copied from class: AbstractChannel

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

Overrides:

doRegister in class AbstractChannel

Throws:

java.lang.Exception

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(java.lang.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(java.lang.Object holder,
                                        ByteBuf buf,
                                        ByteBufAllocator alloc,
                                        int capacity)

checkResolvable

protected static void checkResolvable(java.net.InetSocketAddress addr)

doReadBytes

protected final int doReadBytes(ByteBuf byteBuf)
                         throws java.lang.Exception

Read bytes into the given ByteBuf and return the amount.

Throws:

java.lang.Exception

doWriteBytes

protected final int doWriteBytes(ByteBuf buf,
                                 int writeSpinCount)
                          throws java.lang.Exception

Throws:

java.lang.Exception