AbstractEpollStreamChannel (Netty/Transport/Native/Epoll 4.1.33.Final API)

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

All Implemented Interfaces:

io.netty.channel.Channel, io.netty.channel.ChannelOutboundInvoker, io.netty.channel.socket.DuplexChannel, io.netty.channel.unix.UnixChannel, io.netty.util.AttributeMap, Comparable<io.netty.channel.Channel>

Direct Known Subclasses:

EpollDomainSocketChannel, EpollSocketChannel
```
public abstract class AbstractEpollStreamChannel
extends io.netty.channel.AbstractChannel
implements io.netty.channel.socket.DuplexChannel
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class AbstractEpollStreamChannel.SpliceInTask
- 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

Nested Classes
Modifier and Type	Class and Description
`protected class`	`AbstractEpollStreamChannel.SpliceInTask`

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
Modifier	Constructor and Description
`protected`	`AbstractEpollStreamChannel(io.netty.channel.Channel parent, int fd)`
`protected`	`AbstractEpollStreamChannel(int fd)`
`protected`	`AbstractEpollStreamChannel(io.netty.channel.epoll.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()`
`protected void`	`doBeginRead()`
`protected void`	`doBind(SocketAddress local)`
`protected void`	`doClose()`
`protected boolean`	`doConnect(SocketAddress remoteAddress, SocketAddress localAddress)` Connect to the remote peer
`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 void`	`doShutdownOutput()`
`protected void`	`doWrite(io.netty.channel.ChannelOutboundBuffer in)`
`protected int`	`doWriteBytes(io.netty.channel.ChannelOutboundBuffer in, io.netty.buffer.ByteBuf buf)`
`protected int`	`doWriteSingle(io.netty.channel.ChannelOutboundBuffer in)` Attempt to write a single object.
`io.netty.channel.unix.FileDescriptor`	`fd()`
`protected Object`	`filterOutboundMessage(Object msg)`
`boolean`	`isActive()`
`protected boolean`	`isCompatible(io.netty.channel.EventLoop loop)`
`boolean`	`isInputShutdown()`
`boolean`	`isOpen()`
`boolean`	`isOutputShutdown()`
`boolean`	`isShutdown()`
`protected SocketAddress`	`localAddress0()`
`io.netty.channel.ChannelMetadata`	`metadata()`
`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.
`protected io.netty.channel.epoll.AbstractEpollChannel.AbstractEpollUnsafe`	`newUnsafe()`
`protected SocketAddress`	`remoteAddress0()`
`io.netty.channel.ChannelFuture`	`shutdown()`
`io.netty.channel.ChannelFuture`	`shutdown(io.netty.channel.ChannelPromise promise)`
`io.netty.channel.ChannelFuture`	`shutdownInput()`
`io.netty.channel.ChannelFuture`	`shutdownInput(io.netty.channel.ChannelPromise promise)`
`io.netty.channel.ChannelFuture`	`shutdownOutput()`
`io.netty.channel.ChannelFuture`	`shutdownOutput(io.netty.channel.ChannelPromise promise)`
`io.netty.channel.ChannelFuture`	`spliceTo(AbstractEpollStreamChannel ch, int len)` Splice from this `AbstractEpollStreamChannel` to another `AbstractEpollStreamChannel`.
`io.netty.channel.ChannelFuture`	`spliceTo(AbstractEpollStreamChannel ch, int len, io.netty.channel.ChannelPromise promise)` Splice from this `AbstractEpollStreamChannel` to another `AbstractEpollStreamChannel`.
`io.netty.channel.ChannelFuture`	`spliceTo(io.netty.channel.unix.FileDescriptor ch, int offset, int len)` Splice from this `AbstractEpollStreamChannel` to another `FileDescriptor`.
`io.netty.channel.ChannelFuture`	`spliceTo(io.netty.channel.unix.FileDescriptor ch, int offset, int len, io.netty.channel.ChannelPromise promise)` Splice from this `AbstractEpollStreamChannel` to another `FileDescriptor`.

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, equals, eventLoop, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, localAddress, newChannelPipeline, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, remoteAddress, toString, unsafe, 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
  - flags
```
protected int flags
```
  - active
```
protected volatile boolean active
```
- Constructor Detail
  - AbstractEpollStreamChannel
```
protected AbstractEpollStreamChannel(io.netty.channel.Channel parent,
                                     int fd)
```
  - AbstractEpollStreamChannel
```
protected AbstractEpollStreamChannel(int fd)
```
  - AbstractEpollStreamChannel
```
protected AbstractEpollStreamChannel(io.netty.channel.epoll.LinuxSocket fd,
                                     boolean active)
```
- Method Detail
  - newUnsafe
```
protected io.netty.channel.epoll.AbstractEpollChannel.AbstractEpollUnsafe newUnsafe()
```
  - metadata
```
public io.netty.channel.ChannelMetadata metadata()
```
    Specified by:
    
    metadata in interface io.netty.channel.Channel
  - spliceTo
```
public final io.netty.channel.ChannelFuture spliceTo(AbstractEpollStreamChannel ch,
                                                     int len)
```
    Splice from this AbstractEpollStreamChannel to another AbstractEpollStreamChannel. The len is the number of bytes to splice. If using Integer.MAX_VALUE it will splice until the ChannelFuture was canceled or it was failed. Please note:
    - both channels need to be registered to the same EventLoop, otherwise an IllegalArgumentException is thrown.
    - EpollChannelConfig.getEpollMode() must be EpollMode.LEVEL_TRIGGERED for this and the target AbstractEpollStreamChannel
  - spliceTo
```
public final io.netty.channel.ChannelFuture spliceTo(AbstractEpollStreamChannel ch,
                                                     int len,
                                                     io.netty.channel.ChannelPromise promise)
```
    Splice from this AbstractEpollStreamChannel to another AbstractEpollStreamChannel. The len is the number of bytes to splice. If using Integer.MAX_VALUE it will splice until the ChannelFuture was canceled or it was failed. Please note:
    - both channels need to be registered to the same EventLoop, otherwise an IllegalArgumentException is thrown.
    - EpollChannelConfig.getEpollMode() must be EpollMode.LEVEL_TRIGGERED for this and the target AbstractEpollStreamChannel
  - spliceTo
```
public final io.netty.channel.ChannelFuture spliceTo(io.netty.channel.unix.FileDescriptor ch,
                                                     int offset,
                                                     int len)
```
    Splice from this AbstractEpollStreamChannel to another FileDescriptor. The offset is the offset for the FileDescriptor and len is the number of bytes to splice. If using Integer.MAX_VALUE it will splice until the ChannelFuture was canceled or it was failed. Please note:
    - EpollChannelConfig.getEpollMode() must be EpollMode.LEVEL_TRIGGERED for this AbstractEpollStreamChannel
    - the FileDescriptor will not be closed after the ChannelFuture is notified
    - this channel must be registered to an event loop or IllegalStateException will be thrown.
  - spliceTo
```
public final io.netty.channel.ChannelFuture spliceTo(io.netty.channel.unix.FileDescriptor ch,
                                                     int offset,
                                                     int len,
                                                     io.netty.channel.ChannelPromise promise)
```
    Splice from this AbstractEpollStreamChannel to another FileDescriptor. The offset is the offset for the FileDescriptor and len is the number of bytes to splice. If using Integer.MAX_VALUE it will splice until the ChannelFuture was canceled or it was failed. Please note:
    - EpollChannelConfig.getEpollMode() must be EpollMode.LEVEL_TRIGGERED for this AbstractEpollStreamChannel
    - the FileDescriptor will not be closed after the ChannelPromise is notified
    - this channel must be registered to an event loop or IllegalStateException will be thrown.
  - doWrite
```
protected void doWrite(io.netty.channel.ChannelOutboundBuffer in)
                throws Exception
```
    Specified by:
    
    doWrite in class io.netty.channel.AbstractChannel
    
    Throws:
    
    Exception
  - doWriteSingle
```
protected int doWriteSingle(io.netty.channel.ChannelOutboundBuffer in)
                     throws Exception
```
    Attempt to write a single object.
    Parameters:
    
    in - the collection which contains objects to write.
    
    Returns:
    The value that should be decremented from the write quantum which starts at ChannelConfig.getWriteSpinCount(). The typical use cases are as follows:
    
    0 - if no write was attempted. This is appropriate if an empty ByteBuf (or other empty content) is encountered
    
    1 - if a single call to write data was made to the OS
    
    ChannelUtils.WRITE_STATUS_SNDBUF_FULL - if an attempt to write data was made to the OS, but no data was accepted
    Throws:
    
    Exception - If an I/O error occurs.
  - filterOutboundMessage
```
protected Object filterOutboundMessage(Object msg)
```
    Overrides:
    
    filterOutboundMessage in class io.netty.channel.AbstractChannel
  - doShutdownOutput
```
@UnstableApi
protected final void doShutdownOutput()
                                            throws Exception
```
    Overrides:
    
    doShutdownOutput in class io.netty.channel.AbstractChannel
    
    Throws:
    
    Exception
  - isOutputShutdown
```
public boolean isOutputShutdown()
```
    Specified by:
    
    isOutputShutdown in interface io.netty.channel.socket.DuplexChannel
  - isInputShutdown
```
public boolean isInputShutdown()
```
    Specified by:
    
    isInputShutdown in interface io.netty.channel.socket.DuplexChannel
  - isShutdown
```
public boolean isShutdown()
```
    Specified by:
    
    isShutdown in interface io.netty.channel.socket.DuplexChannel
  - shutdownOutput
```
public io.netty.channel.ChannelFuture shutdownOutput()
```
    Specified by:
    
    shutdownOutput in interface io.netty.channel.socket.DuplexChannel
  - shutdownOutput
```
public io.netty.channel.ChannelFuture shutdownOutput(io.netty.channel.ChannelPromise promise)
```
    Specified by:
    
    shutdownOutput in interface io.netty.channel.socket.DuplexChannel
  - shutdownInput
```
public io.netty.channel.ChannelFuture shutdownInput()
```
    Specified by:
    
    shutdownInput in interface io.netty.channel.socket.DuplexChannel
  - shutdownInput
```
public io.netty.channel.ChannelFuture shutdownInput(io.netty.channel.ChannelPromise promise)
```
    Specified by:
    
    shutdownInput in interface io.netty.channel.socket.DuplexChannel
  - shutdown
```
public io.netty.channel.ChannelFuture shutdown()
```
    Specified by:
    
    shutdown in interface io.netty.channel.socket.DuplexChannel
  - shutdown
```
public io.netty.channel.ChannelFuture shutdown(io.netty.channel.ChannelPromise promise)
```
    Specified by:
    
    shutdown in interface io.netty.channel.socket.DuplexChannel
  - doClose
```
protected void doClose()
                throws Exception
```
    Throws:
    
    Exception
  - fd
```
public final io.netty.channel.unix.FileDescriptor fd()
```
    Specified by:
    
    fd in interface io.netty.channel.unix.UnixChannel
  - config
```
public abstract EpollChannelConfig config()
```
    Specified by:
    
    config in interface io.netty.channel.Channel
  - isActive
```
public boolean isActive()
```
    Specified by:
    
    isActive in interface io.netty.channel.Channel
  - doDisconnect
```
protected void doDisconnect()
                     throws Exception
```
    Specified by:
    
    doDisconnect in class io.netty.channel.AbstractChannel
    
    Throws:
    
    Exception
  - isCompatible
```
protected boolean isCompatible(io.netty.channel.EventLoop loop)
```
    Specified by:
    
    isCompatible in class io.netty.channel.AbstractChannel
  - 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 final 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.channel.ChannelOutboundBuffer in,
                                 io.netty.buffer.ByteBuf buf)
                          throws Exception
```
    Throws:
    
    Exception
  - doBind
```
protected void doBind(SocketAddress local)
               throws Exception
```
    Specified by:
    
    doBind in class io.netty.channel.AbstractChannel
    
    Throws:
    
    Exception
  - doConnect
```
protected boolean doConnect(SocketAddress remoteAddress,
                            SocketAddress localAddress)
                     throws Exception
```
    Connect to the remote peer
    
    Throws:
    
    Exception
  - localAddress0
```
protected SocketAddress localAddress0()
```
    Specified by:
    
    localAddress0 in class io.netty.channel.AbstractChannel
  - remoteAddress0
```
protected SocketAddress remoteAddress0()
```
    Specified by:
    
    remoteAddress0 in class io.netty.channel.AbstractChannel

Class AbstractEpollStreamChannel

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

flags

active

Constructor Detail

AbstractEpollStreamChannel

AbstractEpollStreamChannel

AbstractEpollStreamChannel

Method Detail

newUnsafe

metadata

spliceTo

spliceTo

spliceTo

spliceTo

doWrite

doWriteSingle

filterOutboundMessage

doShutdownOutput

isOutputShutdown

isInputShutdown

isShutdown

shutdownOutput

shutdownOutput

shutdownInput

shutdownInput

shutdown

shutdown

doClose

fd

config

isActive

doDisconnect

isCompatible

isOpen

doDeregister

doBeginRead

doRegister

newDirectBuffer

newDirectBuffer

checkResolvable

doReadBytes

doWriteBytes

doBind

doConnect

localAddress0

remoteAddress0