AbstractEpollStreamChannel

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

All Implemented Interfaces:

Channel, ChannelOutboundInvoker, DuplexChannel, UnixChannel, AttributeMap, java.lang.Comparable<Channel>

Direct Known Subclasses:

EpollDomainSocketChannel, EpollSocketChannel
```
public abstract class AbstractEpollStreamChannel
extends AbstractEpollChannel
implements DuplexChannel
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private class`	`AbstractEpollStreamChannel.EpollSocketWritableByteChannel`
`(package private) class`	`AbstractEpollStreamChannel.EpollStreamUnsafe`
`private class`	`AbstractEpollStreamChannel.SpliceFdTask`
`private class`	`AbstractEpollStreamChannel.SpliceInChannelTask`
`protected class`	`AbstractEpollStreamChannel.SpliceInTask`
`private class`	`AbstractEpollStreamChannel.SpliceOutTask`

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

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
`private java.nio.channels.WritableByteChannel`	`byteChannel`
`private static java.nio.channels.ClosedChannelException`	`CLEAR_SPLICE_QUEUE_CLOSED_CHANNEL_EXCEPTION`
`private ChannelPromise`	`connectPromise` The future of the current connection attempt.
`private java.util.concurrent.ScheduledFuture<?>`	`connectTimeoutFuture`
`private static java.nio.channels.ClosedChannelException`	`DO_CLOSE_CLOSED_CHANNEL_EXCEPTION`
`private static java.lang.String`	`EXPECTED_TYPES`
`private static java.nio.channels.ClosedChannelException`	`FAIL_SPLICE_IF_CLOSED_CLOSED_CHANNEL_EXCEPTION`
`private static InternalLogger`	`logger`
`private static ChannelMetadata`	`METADATA`
`private FileDescriptor`	`pipeIn`
`private FileDescriptor`	`pipeOut`
`private java.net.SocketAddress`	`requestedRemoteAddress`
`private static java.nio.channels.ClosedChannelException`	`SPLICE_TO_CLOSED_CHANNEL_EXCEPTION`
`private java.util.Queue<AbstractEpollStreamChannel.SpliceInTask>`	`spliceQueue`

Fields inherited from class io.netty.channel.epoll.AbstractEpollChannel
active, epollInReadyRunnablePending, flags, inputClosedSeenErrorOnRead, socket

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractEpollStreamChannel(Channel parent, int fd)`
`(package private)`	`AbstractEpollStreamChannel(Channel parent, LinuxSocket fd)`
`protected`	`AbstractEpollStreamChannel(int fd)`
`(package private)`	`AbstractEpollStreamChannel(LinuxSocket fd)`
`protected`	`AbstractEpollStreamChannel(LinuxSocket fd, boolean active)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`addToSpliceQueue(AbstractEpollStreamChannel.SpliceInTask task)`
`private void`	`addToSpliceQueue0(AbstractEpollStreamChannel.SpliceInTask task)`
`private void`	`clearSpliceQueue()`
`protected void`	`doClose()` Close the `Channel`
`protected boolean`	`doConnect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress)` Connect to the remote peer
`protected void`	`doWrite(ChannelOutboundBuffer in)` Flush the content of the given buffer to the remote peer.
`private boolean`	`doWriteMultiple(ChannelOutboundBuffer in, int writeSpinCount)`
`protected boolean`	`doWriteSingle(ChannelOutboundBuffer in, int writeSpinCount)`
`private void`	`failSpliceIfClosed(ChannelPromise promise)`
`protected java.lang.Object`	`filterOutboundMessage(java.lang.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`	`isInputShutdown()` Returns `true` if and only if the remote peer shut down its output so that no more data is received from this channel.
`boolean`	`isOutputShutdown()`
`boolean`	`isShutdown()` Determine if both the input and output of this channel have been shutdown.
`ChannelMetadata`	`metadata()` Return the `ChannelMetadata` of the `Channel` which describe the nature of the `Channel`.
`protected AbstractEpollChannel.AbstractEpollUnsafe`	`newUnsafe()` Create a new `AbstractChannel.AbstractUnsafe` instance which will be used for the life-time of the `Channel`
`private static void`	`safeClosePipe(FileDescriptor fd)`
`ChannelFuture`	`shutdown()` Will shutdown the input and output sides of this channel.
`ChannelFuture`	`shutdown(ChannelPromise promise)` Will shutdown the input and output sides of this channel.
`private void`	`shutdown0(ChannelPromise promise)`
`ChannelFuture`	`shutdownInput()`
`ChannelFuture`	`shutdownInput(ChannelPromise promise)` Will shutdown the input and notify `ChannelPromise`.
`private void`	`shutdownInput0(ChannelPromise promise)`
`ChannelFuture`	`shutdownOutput()`
`ChannelFuture`	`shutdownOutput(ChannelPromise promise)` Will shutdown the output and notify `ChannelPromise`.
`private void`	`shutdownOutput0(ChannelPromise promise)`
`ChannelFuture`	`spliceTo(AbstractEpollStreamChannel ch, int len)` Splice from this `AbstractEpollStreamChannel` to another `AbstractEpollStreamChannel`.
`ChannelFuture`	`spliceTo(AbstractEpollStreamChannel ch, int len, ChannelPromise promise)` Splice from this `AbstractEpollStreamChannel` to another `AbstractEpollStreamChannel`.
`ChannelFuture`	`spliceTo(FileDescriptor ch, int offset, int len)` Splice from this `AbstractEpollStreamChannel` to another `FileDescriptor`.
`ChannelFuture`	`spliceTo(FileDescriptor ch, int offset, int len, ChannelPromise promise)` Splice from this `AbstractEpollStreamChannel` to another `FileDescriptor`.
`private boolean`	`writeBytes(ChannelOutboundBuffer in, ByteBuf buf, int writeSpinCount)` Write bytes form the given `ByteBuf` to the underlying `Channel`.
`private boolean`	`writeBytesMultiple(ChannelOutboundBuffer in, java.nio.ByteBuffer[] nioBuffers, int nioBufferCnt, long expectedWrittenBytes, int writeSpinCount)`
`private boolean`	`writeBytesMultiple(ChannelOutboundBuffer in, IovArray array, int writeSpinCount)`
`private boolean`	`writeDefaultFileRegion(ChannelOutboundBuffer in, DefaultFileRegion region, int writeSpinCount)` Write a `DefaultFileRegion`
`private boolean`	`writeFileRegion(ChannelOutboundBuffer in, FileRegion region, int writeSpinCount)`

Methods inherited from class io.netty.channel.epoll.AbstractEpollChannel
checkResolvable, clearEpollIn, clearFlag, config, doBeginRead, doDeregister, doDisconnect, doReadBytes, doRegister, doWriteBytes, fd, isActive, isAllowHalfClosure, isCompatible, isFlagSet, isOpen, isSoErrorZero, newDirectBuffer, newDirectBuffer, setFlag, shouldBreakEpollInReady

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, doBind, equals, eventLoop, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, localAddress, localAddress0, newChannelPipeline, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, remoteAddress, remoteAddress0, 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
  - METADATA
```
private static final ChannelMetadata METADATA
```
  - EXPECTED_TYPES
```
private static final java.lang.String EXPECTED_TYPES
```
  - logger
```
private static final InternalLogger logger
```
  - DO_CLOSE_CLOSED_CHANNEL_EXCEPTION
```
private static final java.nio.channels.ClosedChannelException DO_CLOSE_CLOSED_CHANNEL_EXCEPTION
```
  - CLEAR_SPLICE_QUEUE_CLOSED_CHANNEL_EXCEPTION
```
private static final java.nio.channels.ClosedChannelException CLEAR_SPLICE_QUEUE_CLOSED_CHANNEL_EXCEPTION
```
  - SPLICE_TO_CLOSED_CHANNEL_EXCEPTION
```
private static final java.nio.channels.ClosedChannelException SPLICE_TO_CLOSED_CHANNEL_EXCEPTION
```
  - FAIL_SPLICE_IF_CLOSED_CLOSED_CHANNEL_EXCEPTION
```
private static final java.nio.channels.ClosedChannelException FAIL_SPLICE_IF_CLOSED_CLOSED_CHANNEL_EXCEPTION
```
  - connectPromise
```
private ChannelPromise connectPromise
```
    The future of the current connection attempt. If not null, subsequent connection attempts will fail.
  - connectTimeoutFuture
```
private java.util.concurrent.ScheduledFuture<?> connectTimeoutFuture
```
  - requestedRemoteAddress
```
private java.net.SocketAddress requestedRemoteAddress
```
  - spliceQueue
```
private java.util.Queue<AbstractEpollStreamChannel.SpliceInTask> spliceQueue
```
  - pipeIn
```
private FileDescriptor pipeIn
```
  - pipeOut
```
private FileDescriptor pipeOut
```
  - byteChannel
```
private java.nio.channels.WritableByteChannel byteChannel
```
- Constructor Detail
  - AbstractEpollStreamChannel
```
protected AbstractEpollStreamChannel(Channel parent,
                                     int fd)
```
  - AbstractEpollStreamChannel
```
protected AbstractEpollStreamChannel(int fd)
```
  - AbstractEpollStreamChannel
```
AbstractEpollStreamChannel(LinuxSocket fd)
```
  - AbstractEpollStreamChannel
```
AbstractEpollStreamChannel(Channel parent,
                           LinuxSocket fd)
```
  - AbstractEpollStreamChannel
```
protected AbstractEpollStreamChannel(LinuxSocket fd,
                                     boolean active)
```
- Method Detail
  - newUnsafe
```
protected 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
    
    Specified by:
    
    newUnsafe in class AbstractEpollChannel
  - 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
    
    Overrides:
    
    metadata in class AbstractEpollChannel
  - spliceTo
```
public final 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 ChannelFuture spliceTo(AbstractEpollStreamChannel ch,
                                    int len,
                                    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 ChannelFuture spliceTo(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 ChannelFuture spliceTo(FileDescriptor ch,
                                    int offset,
                                    int len,
                                    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.
  - failSpliceIfClosed
```
private void failSpliceIfClosed(ChannelPromise promise)
```
  - writeBytes
```
private boolean writeBytes(ChannelOutboundBuffer in,
                           ByteBuf buf,
                           int writeSpinCount)
                    throws java.lang.Exception
```
    Write bytes form the given ByteBuf to the underlying Channel.
    
    Parameters:
    
    buf - the ByteBuf from which the bytes should be written
    
    Throws:
    
    java.lang.Exception
  - writeBytesMultiple
```
private boolean writeBytesMultiple(ChannelOutboundBuffer in,
                                   IovArray array,
                                   int writeSpinCount)
                            throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - writeBytesMultiple
```
private boolean writeBytesMultiple(ChannelOutboundBuffer in,
                                   java.nio.ByteBuffer[] nioBuffers,
                                   int nioBufferCnt,
                                   long expectedWrittenBytes,
                                   int writeSpinCount)
                            throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - writeDefaultFileRegion
```
private boolean writeDefaultFileRegion(ChannelOutboundBuffer in,
                                       DefaultFileRegion region,
                                       int writeSpinCount)
                                throws java.lang.Exception
```
    Write a DefaultFileRegion
    
    Parameters:
    
    region - the DefaultFileRegion from which the bytes should be written
    
    Returns:
    
    amount the amount of written bytes
    
    Throws:
    
    java.lang.Exception
  - writeFileRegion
```
private boolean writeFileRegion(ChannelOutboundBuffer in,
                                FileRegion region,
                                int writeSpinCount)
                         throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - doWrite
```
protected void doWrite(ChannelOutboundBuffer in)
                throws java.lang.Exception
```
    Description copied from class: AbstractChannel
    
    Flush the content of the given buffer to the remote peer.
    
    Specified by:
    
    doWrite in class AbstractChannel
    
    Throws:
    
    java.lang.Exception
  - doWriteSingle
```
protected boolean doWriteSingle(ChannelOutboundBuffer in,
                                int writeSpinCount)
                         throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - doWriteMultiple
```
private boolean doWriteMultiple(ChannelOutboundBuffer in,
                                int writeSpinCount)
                         throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - filterOutboundMessage
```
protected java.lang.Object filterOutboundMessage(java.lang.Object msg)
```
    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
  - shutdownOutput0
```
private void shutdownOutput0(ChannelPromise promise)
```
  - shutdownInput0
```
private void shutdownInput0(ChannelPromise promise)
```
  - shutdown0
```
private void shutdown0(ChannelPromise promise)
```
  - isOutputShutdown
```
public boolean isOutputShutdown()
```
    Specified by:
    
    isOutputShutdown in interface DuplexChannel
    
    See Also:
    
    Socket.isOutputShutdown()
  - isInputShutdown
```
public boolean isInputShutdown()
```
    Description copied from interface: DuplexChannel
    
    Returns true if and only if the remote peer shut down its output so that no more data is received from this channel. Note that the semantic of this method is different from that of Socket.shutdownInput() and Socket.isInputShutdown().
    
    Specified by:
    
    isInputShutdown in interface DuplexChannel
  - isShutdown
```
public boolean isShutdown()
```
    Description copied from interface: DuplexChannel
    
    Determine if both the input and output of this channel have been shutdown.
    
    Specified by:
    
    isShutdown in interface DuplexChannel
  - shutdownOutput
```
public ChannelFuture shutdownOutput()
```
    Specified by:
    
    shutdownOutput in interface DuplexChannel
    
    See Also:
    
    Socket.shutdownOutput()
  - shutdownOutput
```
public ChannelFuture shutdownOutput(ChannelPromise promise)
```
    Description copied from interface: DuplexChannel
    
    Will shutdown the output and notify ChannelPromise.
    
    Specified by:
    
    shutdownOutput in interface DuplexChannel
    
    See Also:
    
    Socket.shutdownOutput()
  - shutdownInput
```
public ChannelFuture shutdownInput()
```
    Specified by:
    
    shutdownInput in interface DuplexChannel
    
    See Also:
    
    Socket.shutdownInput()
  - shutdownInput
```
public ChannelFuture shutdownInput(ChannelPromise promise)
```
    Description copied from interface: DuplexChannel
    
    Will shutdown the input and notify ChannelPromise.
    
    Specified by:
    
    shutdownInput in interface DuplexChannel
    
    See Also:
    
    Socket.shutdownInput()
  - shutdown
```
public ChannelFuture shutdown()
```
    Description copied from interface: DuplexChannel
    
    Will shutdown the input and output sides of this channel.
    
    Specified by:
    
    shutdown in interface DuplexChannel
    
    Returns:
    
    will be completed when both shutdown operations complete.
  - shutdown
```
public ChannelFuture shutdown(ChannelPromise promise)
```
    Description copied from interface: DuplexChannel
    
    Will shutdown the input and output sides of this channel.
    
    Specified by:
    
    shutdown in interface DuplexChannel
    
    Parameters:
    
    promise - will be completed when both shutdown operations complete.
    
    Returns:
    
    will be completed when both shutdown operations complete.
  - doClose
```
protected void doClose()
                throws java.lang.Exception
```
    Description copied from class: AbstractChannel
    
    Close the Channel
    
    Overrides:
    
    doClose in class AbstractEpollChannel
    
    Throws:
    
    java.lang.Exception
  - clearSpliceQueue
```
private void clearSpliceQueue()
```
  - 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
  - safeClosePipe
```
private static void safeClosePipe(FileDescriptor fd)
```
  - addToSpliceQueue
```
private void addToSpliceQueue(AbstractEpollStreamChannel.SpliceInTask task)
```
  - addToSpliceQueue0
```
private void addToSpliceQueue0(AbstractEpollStreamChannel.SpliceInTask task)
```

Class AbstractEpollStreamChannel

Nested Class Summary

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

Nested classes/interfaces inherited from class io.netty.channel.AbstractChannel

Nested classes/interfaces inherited from interface io.netty.channel.Channel

Field Summary

Fields inherited from class io.netty.channel.epoll.AbstractEpollChannel

Constructor Summary

Method Summary

Methods inherited from class io.netty.channel.epoll.AbstractEpollChannel

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

METADATA

EXPECTED_TYPES

logger

DO_CLOSE_CLOSED_CHANNEL_EXCEPTION

CLEAR_SPLICE_QUEUE_CLOSED_CHANNEL_EXCEPTION

SPLICE_TO_CLOSED_CHANNEL_EXCEPTION

FAIL_SPLICE_IF_CLOSED_CLOSED_CHANNEL_EXCEPTION

connectPromise

connectTimeoutFuture

requestedRemoteAddress

spliceQueue

pipeIn

pipeOut

byteChannel

Constructor Detail

AbstractEpollStreamChannel

AbstractEpollStreamChannel

AbstractEpollStreamChannel

AbstractEpollStreamChannel

AbstractEpollStreamChannel

Method Detail

newUnsafe

metadata

spliceTo

spliceTo

spliceTo

spliceTo

failSpliceIfClosed

writeBytes

writeBytesMultiple

writeBytesMultiple

writeDefaultFileRegion

writeFileRegion

doWrite

doWriteSingle

doWriteMultiple

filterOutboundMessage

shutdownOutput0

shutdownInput0

shutdown0

isOutputShutdown

isInputShutdown

isShutdown

shutdownOutput

shutdownOutput

shutdownInput

shutdownInput

shutdown

shutdown

doClose

clearSpliceQueue

doConnect

safeClosePipe

addToSpliceQueue

addToSpliceQueue0