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, 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 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	Description
`protected boolean`	`active`
`private ChannelPromise`	`connectPromise`	The future of the current connection attempt.
`private Future<?>`	`connectTimeoutFuture`
`(package private) boolean`	`epollInReadyRunnablePending`
`protected int`	`flags`
`(package private) boolean`	`inputClosedSeenErrorOnRead`
`private java.net.SocketAddress`	`local`
`private static ChannelMetadata`	`METADATA`
`private java.net.SocketAddress`	`remote`
`private java.net.SocketAddress`	`requestedRemoteAddress`
`protected LinuxSocket`	`socket`

Constructor Summary

Constructors
Constructor	Description
`AbstractEpollChannel(Channel parent, LinuxSocket fd, boolean active)`
`AbstractEpollChannel(Channel parent, LinuxSocket fd, java.net.SocketAddress remote)`
`AbstractEpollChannel(LinuxSocket fd)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	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`	`doBind(java.net.SocketAddress local)`	Bind the `Channel` to the `SocketAddress`
`protected void`	`doClose()`	Close the `Channel`
`protected boolean`	`doConnect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress)`	Connect to the remote peer
`(package private) boolean`	`doConnect0(java.net.SocketAddress remote)`
`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(ChannelOutboundBuffer in, ByteBuf buf)`
`(package private) long`	`doWriteOrSendBytes(ByteBuf data, java.net.InetSocketAddress remoteAddress, boolean fastOpen)`	Write bytes to the socket, with or without a remote address.
`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 java.net.SocketAddress`	`localAddress0()`	Returns the `SocketAddress` which is bound locally.
`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`
`protected java.net.SocketAddress`	`remoteAddress0()`	Return the `SocketAddress` which the `Channel` is connected to.
`(package private) void`	`resetCachedAddresses()`
`protected 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, doShutdownOutput, doWrite, equals, eventLoop, filterOutboundMessage, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, localAddress, maxMessagesPerWrite, newChannelPipeline, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, remoteAddress, toString, unsafe, validateFileRegion, 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.util.AttributeMap
attr, hasAttr

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.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
```
  - socket
```
protected final LinuxSocket socket
```
  - 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 java.net.SocketAddress requestedRemoteAddress
```
  - local
```
private volatile java.net.SocketAddress local
```
  - remote
```
private volatile java.net.SocketAddress remote
```
  - flags
```
protected int flags
```
  - inputClosedSeenErrorOnRead
```
boolean inputClosedSeenErrorOnRead
```
  - epollInReadyRunnablePending
```
boolean epollInReadyRunnablePending
```
  - active
```
protected volatile boolean active
```
- Constructor Detail
  - AbstractEpollChannel
```
AbstractEpollChannel(LinuxSocket fd)
```
  - AbstractEpollChannel
```
AbstractEpollChannel(Channel parent,
                     LinuxSocket fd,
                     boolean active)
```
  - AbstractEpollChannel
```
AbstractEpollChannel(Channel parent,
                     LinuxSocket fd,
                     java.net.SocketAddress remote)
```
- Method Detail
  - isSoErrorZero
```
static boolean isSoErrorZero(Socket fd)
```
  - setFlag
```
protected 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
  - resetCachedAddresses
```
void resetCachedAddresses()
```
  - 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
```
private static 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(ChannelOutboundBuffer in,
                                 ByteBuf buf)
                          throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - doWriteOrSendBytes
```
final long doWriteOrSendBytes(ByteBuf data,
                              java.net.InetSocketAddress remoteAddress,
                              boolean fastOpen)
                       throws java.io.IOException
```
    Write bytes to the socket, with or without a remote address. Used for datagram and TCP client fast open writes.
    
    Throws:
    
    java.io.IOException
  - doBind
```
protected void doBind(java.net.SocketAddress local)
               throws java.lang.Exception
```
    Description copied from class: AbstractChannel
    
    Bind the Channel to the SocketAddress
    
    Specified by:
    
    doBind in class AbstractChannel
    
    Throws:
    
    java.lang.Exception
  - doConnect
```
protected boolean doConnect(java.net.SocketAddress remoteAddress,
                            java.net.SocketAddress localAddress)
                     throws java.lang.Exception
```
    Connect to the remote peer
    
    Throws:
    
    java.lang.Exception
  - doConnect0
```
boolean doConnect0(java.net.SocketAddress remote)
            throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - localAddress0
```
protected java.net.SocketAddress localAddress0()
```
    Description copied from class: AbstractChannel
    
    Returns the SocketAddress which is bound locally.
    
    Specified by:
    
    localAddress0 in class AbstractChannel
  - remoteAddress0
```
protected java.net.SocketAddress remoteAddress0()
```
    Description copied from class: AbstractChannel
    
    Return the SocketAddress which the Channel is connected to.
    
    Specified by:
    
    remoteAddress0 in class AbstractChannel

Class AbstractEpollChannel

Nested Class Summary

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

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class io.netty.channel.AbstractChannel

Methods inherited from class io.netty.util.DefaultAttributeMap

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.util.AttributeMap

Methods inherited from interface io.netty.channel.Channel

Methods inherited from interface io.netty.channel.ChannelOutboundInvoker

Methods inherited from interface java.lang.Comparable

Field Detail

METADATA

socket

connectPromise

connectTimeoutFuture

requestedRemoteAddress

local

remote

flags

inputClosedSeenErrorOnRead

epollInReadyRunnablePending

active

Constructor Detail

AbstractEpollChannel

AbstractEpollChannel

AbstractEpollChannel

Method Detail

isSoErrorZero

setFlag

clearFlag

isFlagSet

fd

config

isActive

metadata

doClose

resetCachedAddresses

doDisconnect

isCompatible

isOpen

doDeregister

doBeginRead

shouldBreakEpollInReady

isAllowHalfClosure

clearEpollIn

modifyEvents

doRegister

newUnsafe

newDirectBuffer

newDirectBuffer

newDirectBuffer0

checkResolvable

doReadBytes

doWriteBytes

doWriteOrSendBytes

doBind

doConnect

doConnect0

localAddress0

remoteAddress0