java.lang.Object
- io.netty.util.DefaultAttributeMap
- - io.netty.channel.AbstractChannel
  - - io.netty.channel.epoll.AbstractEpollStreamChannel
    - - io.netty.channel.epoll.EpollSocketChannel

All Implemented Interfaces:

Channel, ChannelOutboundInvoker, DuplexChannel, SocketChannel, UnixChannel, AttributeMap, java.lang.Comparable<Channel>
```
public final class EpollSocketChannel
extends AbstractEpollStreamChannel
implements SocketChannel
```
SocketChannel implementation that uses linux EPOLL Edge-Triggered Mode for maximal performance.

Nested Class Summary
- Nested classes/interfaces inherited from class io.netty.channel.epoll.AbstractEpollStreamChannel
  AbstractEpollStreamChannel.SpliceInTask
- 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

protected LinuxSocket socket

Constructor Summary

Constructors
Constructor	Description
`EpollSocketChannel()`
`EpollSocketChannel(int fd)`
`EpollSocketChannel(InternetProtocolFamily protocol)`	Deprecated. use `EpollServerSocketChannel(SocketProtocolFamily)`.
`EpollSocketChannel(SocketProtocolFamily protocol)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected static void`	`checkResolvable(java.net.InetSocketAddress addr)`
`EpollSocketChannelConfig`	`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 boolean`	`doConnect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress)`	Connect to the remote peer
`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(ChannelPromise promise)`	Is called after the `Channel` is registered with its `EventLoop` as part of the register process.
`protected int`	`doWriteBytes(ChannelOutboundBuffer in, ByteBuf buf)`
`FileDescriptor`	`fd()`	Returns the `FileDescriptor` that is used by this `Channel`.
`boolean`	`isActive()`	Return `true` if the `Channel` is active and so connected.
`protected boolean`	`isCompatible(EventLoop loop)`	Return `true` if the given `EventLoop` is compatible with this instance.
`boolean`	`isOpen()`	Returns `true` if the `Channel` is open and may get active later
`java.net.InetSocketAddress`	`localAddress()`	Returns the local address where this channel is bound to.
`protected java.net.SocketAddress`	`localAddress0()`	Returns the `SocketAddress` which is bound locally.
`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.
`protected io.netty.channel.epoll.AbstractEpollChannel.AbstractEpollUnsafe`	`newUnsafe()`	Create a new `AbstractChannel.AbstractUnsafe` instance which will be used for the life-time of the `Channel`
`ServerSocketChannel`	`parent()`	Returns the parent of this channel.
`protected IoRegistration`	`registration()`
`java.net.InetSocketAddress`	`remoteAddress()`	Returns the remote address where this channel is connected to.
`protected java.net.SocketAddress`	`remoteAddress0()`	Return the `SocketAddress` which the `Channel` is connected to.
`protected void`	`setFlag(int flag)`
`EpollTcpInfo`	`tcpInfo()`	Returns the `TCP_INFO` for the current socket.
`EpollTcpInfo`	`tcpInfo(EpollTcpInfo info)`	Updates and returns the `TCP_INFO` for the current socket.

Methods inherited from class io.netty.channel.epoll.AbstractEpollStreamChannel
doClose, doShutdownOutput, doWrite, doWriteSingle, filterOutboundMessage, isInputShutdown, isOutputShutdown, isShutdown, metadata, shutdown, shutdown, shutdownInput, shutdownInput, shutdownOutput, shutdownOutput, spliceTo, spliceTo, spliceTo, spliceTo

Methods inherited from class io.netty.channel.AbstractChannel
closeFuture, compareTo, doRegister, equals, eventLoop, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, maxMessagesPerWrite, newChannelPipeline, newId, pipeline, toString, unsafe, validateFileRegion, voidPromise

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, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, closeFuture, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, eventLoop, flush, getOption, id, isActive, isOpen, isRegistered, isWritable, metadata, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, pipeline, read, setOption, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from interface java.lang.Comparable
compareTo

Methods inherited from interface io.netty.channel.socket.DuplexChannel
isInputShutdown, isOutputShutdown, isShutdown, shutdown, shutdown, shutdownInput, shutdownInput, shutdownOutput, shutdownOutput

- Field Detail
  - socket
```
protected final LinuxSocket socket
```
  - active
```
protected volatile boolean active
```
- Constructor Detail
  - EpollSocketChannel
```
public EpollSocketChannel()
```
  - EpollSocketChannel
```
@Deprecated
public EpollSocketChannel(InternetProtocolFamily protocol)
```
    Deprecated.
    use EpollServerSocketChannel(SocketProtocolFamily).
  - EpollSocketChannel
```
public EpollSocketChannel(SocketProtocolFamily protocol)
```
  - EpollSocketChannel
```
public EpollSocketChannel(int fd)
```
- Method Detail
  - tcpInfo
```
public EpollTcpInfo tcpInfo()
```
    Returns the TCP_INFO for the current socket. See man 7 tcp.
  - tcpInfo
```
public EpollTcpInfo tcpInfo(EpollTcpInfo info)
```
    Updates and returns the TCP_INFO for the current socket. See man 7 tcp.
  - remoteAddress
```
public java.net.InetSocketAddress remoteAddress()
```
    Description copied from interface: Channel
    
    Returns the remote address where this channel is connected to. The returned SocketAddress is supposed to be down-cast into more concrete type such as InetSocketAddress to retrieve the detailed information.
    
    Specified by:
    
    remoteAddress in interface Channel
    
    Specified by:
    
    remoteAddress in interface SocketChannel
    
    Overrides:
    
    remoteAddress in class AbstractChannel
    
    Returns:
    
    the remote address of this channel. null if this channel is not connected. If this channel is not connected but it can receive messages from arbitrary remote addresses (e.g. DatagramChannel, use DefaultAddressedEnvelope.recipient() to determine the origination of the received message as this method will return null.
  - localAddress
```
public java.net.InetSocketAddress localAddress()
```
    Description copied from interface: Channel
    
    Returns the local address where this channel is bound to. The returned SocketAddress is supposed to be down-cast into more concrete type such as InetSocketAddress to retrieve the detailed information.
    
    Specified by:
    
    localAddress in interface Channel
    
    Specified by:
    
    localAddress in interface SocketChannel
    
    Overrides:
    
    localAddress in class AbstractChannel
    
    Returns:
    
    the local address of this channel. null if this channel is not bound.
  - config
```
public EpollSocketChannelConfig config()
```
    Description copied from interface: Channel
    
    Returns the configuration of this channel.
    
    Specified by:
    
    config in interface Channel
    
    Specified by:
    
    config in interface SocketChannel
  - parent
```
public ServerSocketChannel parent()
```
    Description copied from interface: Channel
    
    Returns the parent of this channel.
    
    Specified by:
    
    parent in interface Channel
    
    Specified by:
    
    parent in interface SocketChannel
    
    Overrides:
    
    parent in class AbstractChannel
    
    Returns:
    
    the parent channel. null if this channel does not have a parent channel.
  - newUnsafe
```
protected io.netty.channel.epoll.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
    
    Overrides:
    
    newUnsafe in class AbstractEpollStreamChannel
  - setFlag
```
protected void setFlag(int flag)
                throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - registration
```
protected final IoRegistration 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
  - 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
  - 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
  - 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 java.lang.Exception
```
    Description copied from class: AbstractChannel
    
    Schedule a read operation.
    
    Specified by:
    
    doBeginRead in class AbstractChannel
    
    Throws:
    
    java.lang.Exception
  - 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.
  - 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.
  - 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
  - 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
  - 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 EpollSocketChannel

Nested Class Summary

Nested classes/interfaces inherited from class io.netty.channel.epoll.AbstractEpollStreamChannel

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.epoll.AbstractEpollStreamChannel

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

Methods inherited from interface io.netty.channel.socket.DuplexChannel

Field Detail

socket

active

Constructor Detail

EpollSocketChannel

EpollSocketChannel

EpollSocketChannel

EpollSocketChannel

Method Detail

tcpInfo

tcpInfo

remoteAddress

localAddress

config

parent

newUnsafe

setFlag

registration

fd

isActive

doDisconnect

isOpen

doDeregister

isCompatible

doBeginRead

doRegister

newDirectBuffer

newDirectBuffer

checkResolvable

doReadBytes

doWriteBytes

doBind

doConnect

localAddress0

remoteAddress0