EpollServerSocketChannel (Netty/Transport/Native/Epoll 4.0.56.Final API)

java.lang.Object
- io.netty.util.DefaultAttributeMap
- - io.netty.channel.AbstractChannel
  - - io.netty.channel.epoll.AbstractEpollServerChannel
    - - io.netty.channel.epoll.EpollServerSocketChannel

All Implemented Interfaces:

io.netty.channel.Channel, io.netty.channel.ServerChannel, io.netty.channel.socket.ServerSocketChannel, UnixChannel, io.netty.util.AttributeMap, Comparable<io.netty.channel.Channel>
```
public final class EpollServerSocketChannel
extends AbstractEpollServerChannel
implements io.netty.channel.socket.ServerSocketChannel
```
ServerSocketChannel implementation that uses linux EPOLL Edge-Triggered Mode for maximal performance.

Nested Class Summary
- Nested classes/interfaces inherited from class io.netty.channel.AbstractChannel
  io.netty.channel.AbstractChannel.AbstractUnsafe
- Nested classes/interfaces inherited from interface io.netty.channel.Channel
  io.netty.channel.Channel.Unsafe

Field Summary

Fields
Modifier and Type Field and Description

protected boolean active

protected int flags

Fields
Modifier and Type	Field and Description
`protected boolean`	`active`
`protected int`	`flags`

Constructor Summary

Constructors
Constructor and Description
`EpollServerSocketChannel()`
`EpollServerSocketChannel(FileDescriptor fd)` Deprecated. Use `EpollServerSocketChannel(Socket, boolean)`. Creates a new `EpollServerSocketChannel` from an existing `FileDescriptor`.
`EpollServerSocketChannel(Socket fd)` Deprecated. Use `EpollServerSocketChannel(Socket, boolean)`. Creates a new `EpollServerSocketChannel` from an existing `Socket`.
`EpollServerSocketChannel(Socket fd, boolean active)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected static void`	`checkResolvable(InetSocketAddress addr)`
`EpollServerSocketChannelConfig`	`config()`
`protected void`	`doBeginRead()`
`protected void`	`doBind(SocketAddress localAddress)`
`protected void`	`doClose()`
`protected void`	`doDeregister()`
`protected void`	`doDisconnect()`
`protected int`	`doReadBytes(io.netty.buffer.ByteBuf byteBuf)` Read bytes into the given `ByteBuf` and return the amount.
`protected void`	`doRegister()`
`protected int`	`doWriteBytes(io.netty.buffer.ByteBuf buf, int writeSpinCount)`
`Socket`	`fd()` Returns the `FileDescriptor` that is used by this `Channel`.
`boolean`	`isActive()`
`protected boolean`	`isCompatible(io.netty.channel.EventLoop loop)`
`boolean`	`isOpen()`
`InetSocketAddress`	`localAddress()`
`protected SocketAddress`	`localAddress0()`
`io.netty.channel.ChannelMetadata`	`metadata()`
`protected io.netty.channel.Channel`	`newChildChannel(int fd, byte[] address, int offset, int len)`
`protected io.netty.buffer.ByteBuf`	`newDirectBuffer(io.netty.buffer.ByteBuf buf)` Returns an off-heap copy of the specified `ByteBuf`, and releases the original one.
`protected io.netty.buffer.ByteBuf`	`newDirectBuffer(Object holder, io.netty.buffer.ByteBuf buf)` Returns an off-heap copy of the specified `ByteBuf`, and releases the specified holder.
`InetSocketAddress`	`remoteAddress()`

Methods inherited from class io.netty.channel.epoll.AbstractEpollServerChannel
doConnect, doWrite, filterOutboundMessage, newUnsafe, remoteAddress0

Methods inherited from class io.netty.channel.AbstractChannel
alloc, bind, bind, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, doShutdownOutput, equals, eventLoop, flush, hashCode, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, newChannelPipeline, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, toString, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from class io.netty.util.DefaultAttributeMap
attr

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.netty.channel.Channel
alloc, bind, bind, close, close, closeFuture, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, eventLoop, flush, isActive, isOpen, isRegistered, isWritable, metadata, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from interface io.netty.util.AttributeMap
attr

Methods inherited from interface java.lang.Comparable
compareTo

- Field Detail
  - flags
```
protected int flags
```
  - active
```
protected volatile boolean active
```
- Constructor Detail
  - EpollServerSocketChannel
```
public EpollServerSocketChannel()
```
  - EpollServerSocketChannel
```
@Deprecated
public EpollServerSocketChannel(FileDescriptor fd)
```
    Deprecated. Use EpollServerSocketChannel(Socket, boolean). Creates a new EpollServerSocketChannel from an existing FileDescriptor.
  - EpollServerSocketChannel
```
@Deprecated
public EpollServerSocketChannel(Socket fd)
```
    Deprecated. Use EpollServerSocketChannel(Socket, boolean). Creates a new EpollServerSocketChannel from an existing Socket.
  - EpollServerSocketChannel
```
public EpollServerSocketChannel(Socket fd,
                                boolean active)
```
- Method Detail
  - isCompatible
```
protected boolean isCompatible(io.netty.channel.EventLoop loop)
```
    Overrides:
    
    isCompatible in class AbstractEpollServerChannel
  - doBind
```
protected void doBind(SocketAddress localAddress)
               throws Exception
```
    Throws:
    
    Exception
  - remoteAddress
```
public InetSocketAddress remoteAddress()
```
    Specified by:
    
    remoteAddress in interface io.netty.channel.Channel
    
    Specified by:
    
    remoteAddress in interface io.netty.channel.socket.ServerSocketChannel
    
    Overrides:
    
    remoteAddress in class io.netty.channel.AbstractChannel
  - localAddress
```
public InetSocketAddress localAddress()
```
    Specified by:
    
    localAddress in interface io.netty.channel.Channel
    
    Specified by:
    
    localAddress in interface io.netty.channel.socket.ServerSocketChannel
    
    Overrides:
    
    localAddress in class io.netty.channel.AbstractChannel
  - config
```
public EpollServerSocketChannelConfig config()
```
    Specified by:
    
    config in interface io.netty.channel.Channel
    
    Specified by:
    
    config in interface io.netty.channel.socket.ServerSocketChannel
  - newChildChannel
```
protected io.netty.channel.Channel newChildChannel(int fd,
                                                   byte[] address,
                                                   int offset,
                                                   int len)
                                            throws Exception
```
    Throws:
    
    Exception
  - fd
```
public final Socket 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()
```
    Specified by:
    
    isActive in interface io.netty.channel.Channel
  - metadata
```
public io.netty.channel.ChannelMetadata metadata()
```
    Specified by:
    
    metadata in interface io.netty.channel.Channel
  - doClose
```
protected void doClose()
                throws Exception
```
    Specified by:
    
    doClose in class io.netty.channel.AbstractChannel
    
    Throws:
    
    Exception
  - doDisconnect
```
protected void doDisconnect()
                     throws Exception
```
    Specified by:
    
    doDisconnect in class io.netty.channel.AbstractChannel
    
    Throws:
    
    Exception
  - isOpen
```
public boolean isOpen()
```
    Specified by:
    
    isOpen in interface io.netty.channel.Channel
  - doDeregister
```
protected void doDeregister()
                     throws Exception
```
    Overrides:
    
    doDeregister in class io.netty.channel.AbstractChannel
    
    Throws:
    
    Exception
  - doBeginRead
```
protected void doBeginRead()
                    throws Exception
```
    Specified by:
    
    doBeginRead in class io.netty.channel.AbstractChannel
    
    Throws:
    
    Exception
  - doRegister
```
protected void doRegister()
                   throws Exception
```
    Overrides:
    
    doRegister in class io.netty.channel.AbstractChannel
    
    Throws:
    
    Exception
  - newDirectBuffer
```
protected final io.netty.buffer.ByteBuf newDirectBuffer(io.netty.buffer.ByteBuf buf)
```
    Returns an off-heap copy of the specified ByteBuf, and releases the original one.
  - newDirectBuffer
```
protected final io.netty.buffer.ByteBuf newDirectBuffer(Object holder,
                                                        io.netty.buffer.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(InetSocketAddress addr)
```
  - doReadBytes
```
protected final int doReadBytes(io.netty.buffer.ByteBuf byteBuf)
                         throws Exception
```
    Read bytes into the given ByteBuf and return the amount.
    
    Throws:
    
    Exception
  - doWriteBytes
```
protected final int doWriteBytes(io.netty.buffer.ByteBuf buf,
                                 int writeSpinCount)
                          throws Exception
```
    Throws:
    
    Exception
  - localAddress0
```
protected SocketAddress localAddress0()
```
    Specified by:
    
    localAddress0 in class io.netty.channel.AbstractChannel

Class EpollServerSocketChannel

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

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.channel.Channel

Methods inherited from interface io.netty.util.AttributeMap

Methods inherited from interface java.lang.Comparable

Field Detail

flags

active

Constructor Detail

EpollServerSocketChannel

EpollServerSocketChannel

EpollServerSocketChannel

EpollServerSocketChannel

Method Detail

isCompatible

doBind

remoteAddress

localAddress

config

newChildChannel

fd

isActive

metadata

doClose

doDisconnect

isOpen

doDeregister

doBeginRead

doRegister

newDirectBuffer

newDirectBuffer

checkResolvable

doReadBytes

doWriteBytes

localAddress0