EpollServerSocketChannel (Netty API Reference (4.1.115.Final))

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

All Implemented Interfaces:

Channel, ChannelOutboundInvoker, ServerChannel, ServerSocketChannel, UnixChannel, AttributeMap, Comparable<Channel>
```
public final class EpollServerSocketChannel
extends AbstractEpollServerChannel
implements 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
  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

protected int flags

protected LinuxSocket socket

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

Constructor Summary

Constructors
Constructor and Description

EpollServerSocketChannel()

EpollServerSocketChannel(int fd)

EpollServerSocketChannel(InternetProtocolFamily protocol)

Constructors
Constructor and Description
`EpollServerSocketChannel()`
`EpollServerSocketChannel(int fd)`
`EpollServerSocketChannel(InternetProtocolFamily protocol)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected static void`	`checkResolvable(InetSocketAddress addr)`
`EpollServerSocketChannelConfig`	`config()` Returns the configuration of this channel.
`protected void`	`doBeginRead()` Schedule a read operation.
`protected void`	`doBind(SocketAddress localAddress)` Bind the `Channel` to the `SocketAddress`
`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(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
`InetSocketAddress`	`localAddress()` Returns the local address where this channel is bound to.
`protected SocketAddress`	`localAddress0()` Returns the `SocketAddress` which is bound locally.
`protected Channel`	`newChildChannel(int fd, byte[] address, int offset, int len)`
`protected ByteBuf`	`newDirectBuffer(ByteBuf buf)` Returns an off-heap copy of the specified `ByteBuf`, and releases the original one.
`protected ByteBuf`	`newDirectBuffer(Object holder, ByteBuf buf)` Returns an off-heap copy of the specified `ByteBuf`, and releases the specified holder.
`InetSocketAddress`	`remoteAddress()` Returns the remote address where this channel is connected to.
`protected void`	`setFlag(int flag)`

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

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, equals, eventLoop, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, maxMessagesPerWrite, newChannelPipeline, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, 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.channel.Channel
alloc, bytesBeforeUnwritable, bytesBeforeWritable, closeFuture, eventLoop, flush, id, isActive, isOpen, isRegistered, isWritable, metadata, parent, pipeline, read, 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
  - socket
```
protected final LinuxSocket socket
```
  - flags
```
protected int flags
```
  - active
```
protected volatile boolean active
```
- Constructor Detail
  - EpollServerSocketChannel
```
public EpollServerSocketChannel()
```
  - EpollServerSocketChannel
```
public EpollServerSocketChannel(InternetProtocolFamily protocol)
```
  - EpollServerSocketChannel
```
public EpollServerSocketChannel(int fd)
```
- Method Detail
  - isCompatible
```
protected boolean isCompatible(EventLoop loop)
```
    Description copied from class: AbstractChannel
    
    Return true if the given EventLoop is compatible with this instance.
    
    Overrides:
    
    isCompatible in class AbstractEpollServerChannel
  - doBind
```
protected void doBind(SocketAddress localAddress)
               throws Exception
```
    Description copied from class: AbstractChannel
    
    Bind the Channel to the SocketAddress
    
    Throws:
    
    Exception
  - remoteAddress
```
public 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 ServerSocketChannel
    
    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 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 ServerSocketChannel
    
    Overrides:
    
    localAddress in class AbstractChannel
    
    Returns:
    
    the local address of this channel. null if this channel is not bound.
  - config
```
public EpollServerSocketChannelConfig config()
```
    Description copied from interface: Channel
    
    Returns the configuration of this channel.
    
    Specified by:
    
    config in interface Channel
    
    Specified by:
    
    config in interface ServerSocketChannel
  - newChildChannel
```
protected Channel newChildChannel(int fd,
                                  byte[] address,
                                  int offset,
                                  int len)
                           throws Exception
```
    Specified by:
    
    newChildChannel in class AbstractEpollServerChannel
    
    Throws:
    
    Exception
  - setFlag
```
protected void setFlag(int flag)
                throws IOException
```
    Throws:
    
    IOException
  - 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
  - doClose
```
protected void doClose()
                throws Exception
```
    Description copied from class: AbstractChannel
    
    Close the Channel
    
    Specified by:
    
    doClose in class AbstractChannel
    
    Throws:
    
    Exception
  - 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
  - doBeginRead
```
protected final void doBeginRead()
                          throws Exception
```
    Description copied from class: AbstractChannel
    
    Schedule a read operation.
    
    Specified by:
    
    doBeginRead in class AbstractChannel
    
    Throws:
    
    Exception
  - doRegister
```
protected void doRegister()
                   throws 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:
    
    Exception
  - 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.
  - 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
  - localAddress0
```
protected SocketAddress localAddress0()
```
    Description copied from class: AbstractChannel
    
    Returns the SocketAddress which is bound locally.
    
    Specified by:
    
    localAddress0 in class 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 io.netty.channel.ChannelOutboundInvoker

Methods inherited from interface java.lang.Comparable

Field Detail

socket

flags

active

Constructor Detail

EpollServerSocketChannel

EpollServerSocketChannel

EpollServerSocketChannel

Method Detail

isCompatible

doBind

remoteAddress

localAddress

config

newChildChannel

setFlag

fd

isActive

doClose

doDisconnect

isOpen

doDeregister

doBeginRead

doRegister

newDirectBuffer

newDirectBuffer

checkResolvable

doReadBytes

doWriteBytes

localAddress0