AbstractEpollServerChannel (Netty API Reference (4.1.128.Final))

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

All Implemented Interfaces:

Channel, ChannelOutboundInvoker, ServerChannel, UnixChannel, AttributeMap, Comparable<Channel>

Direct Known Subclasses:

EpollServerDomainSocketChannel, EpollServerSocketChannel
```
public abstract class AbstractEpollServerChannel
extends AbstractChannel
implements ServerChannel
```

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
Modifier	Constructor and Description
`protected`	`AbstractEpollServerChannel(int fd)`
`protected`	`AbstractEpollServerChannel(LinuxSocket fd)`
`protected`	`AbstractEpollServerChannel(LinuxSocket fd, boolean active)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected static void`	`checkResolvable(InetSocketAddress addr)`
`abstract EpollChannelConfig`	`config()` Returns the configuration of this channel.
`protected void`	`doBeginRead()` Schedule a read operation.
`protected void`	`doBind(SocketAddress local)` Bind the `Channel` to the `SocketAddress`
`protected void`	`doClose()` Close the `Channel`
`protected boolean`	`doConnect(SocketAddress remoteAddress, 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()` Is called after the `Channel` is registered with its `EventLoop` as part of the register process.
`protected void`	`doWrite(ChannelOutboundBuffer in)` Flush the content of the given buffer to the remote peer.
`protected int`	`doWriteBytes(ChannelOutboundBuffer in, ByteBuf buf)`
`FileDescriptor`	`fd()` Returns the `FileDescriptor` that is used by this `Channel`.
`protected Object`	`filterOutboundMessage(Object msg)` Invoked when a new message is added to a `ChannelOutboundBuffer` of this `AbstractChannel`, so that the `Channel` implementation converts the message to another.
`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
`protected SocketAddress`	`localAddress0()` Returns the `SocketAddress` which is bound locally.
`ChannelMetadata`	`metadata()` Return the `ChannelMetadata` of the `Channel` which describe the nature of the `Channel`.
`protected abstract Channel`	`newChildChannel(int fd, byte[] remote, 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.
`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`
`protected InetSocketAddress`	`remoteAddress0()` Return the `SocketAddress` which the `Channel` is connected to.
`protected void`	`setFlag(int flag)`

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, 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.channel.Channel
alloc, bytesBeforeUnwritable, bytesBeforeWritable, closeFuture, config, eventLoop, flush, id, isActive, isOpen, 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
  - socket
```
protected final LinuxSocket socket
```
  - flags
```
protected int flags
```
  - active
```
protected volatile boolean active
```
- Constructor Detail
  - AbstractEpollServerChannel
```
protected AbstractEpollServerChannel(int fd)
```
  - AbstractEpollServerChannel
```
protected AbstractEpollServerChannel(LinuxSocket fd)
```
  - AbstractEpollServerChannel
```
protected AbstractEpollServerChannel(LinuxSocket fd,
                                     boolean active)
```
- Method Detail
  - 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
  - isCompatible
```
protected boolean isCompatible(EventLoop loop)
```
    Description copied from class: AbstractChannel
    
    Return true if the given EventLoop is compatible with this instance.
  - remoteAddress0
```
protected InetSocketAddress remoteAddress0()
```
    Description copied from class: AbstractChannel
    
    Return the SocketAddress which the Channel is connected to.
  - 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
  - doWrite
```
protected void doWrite(ChannelOutboundBuffer in)
                throws Exception
```
    Description copied from class: AbstractChannel
    
    Flush the content of the given buffer to the remote peer.
    
    Specified by:
    
    doWrite in class AbstractChannel
    
    Throws:
    
    Exception
  - filterOutboundMessage
```
protected Object filterOutboundMessage(Object msg)
                                throws Exception
```
    Description copied from class: AbstractChannel
    
    Invoked when a new message is added to a ChannelOutboundBuffer of this AbstractChannel, so that the Channel implementation converts the message to another. (e.g. heap buffer -> direct buffer)
    
    Overrides:
    
    filterOutboundMessage in class AbstractChannel
    
    Throws:
    
    Exception
  - newChildChannel
```
protected abstract Channel newChildChannel(int fd,
                                           byte[] remote,
                                           int offset,
                                           int len)
                                    throws Exception
```
    Throws:
    
    Exception
  - doConnect
```
protected boolean doConnect(SocketAddress remoteAddress,
                            SocketAddress localAddress)
                     throws Exception
```
    Connect to the remote peer
    
    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
  - 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
  - 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
  - doBind
```
protected void doBind(SocketAddress local)
               throws Exception
```
    Description copied from class: AbstractChannel
    
    Bind the Channel to the SocketAddress
    
    Specified by:
    
    doBind in class AbstractChannel
    
    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 AbstractEpollServerChannel

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

AbstractEpollServerChannel

AbstractEpollServerChannel

AbstractEpollServerChannel

Method Detail

metadata

isCompatible

remoteAddress0

newUnsafe

doWrite

filterOutboundMessage

newChildChannel

doConnect

setFlag

fd

config

isActive

doClose

doDisconnect

isOpen

doDeregister

doBeginRead

doRegister

newDirectBuffer

newDirectBuffer

checkResolvable

doReadBytes

doWriteBytes

doBind

localAddress0