Class 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, Comparable<Channel>

Direct Known Subclasses:

EpollDomainSocketChannel, EpollSocketChannel

public abstract class AbstractEpollStreamChannel
extends AbstractEpollChannel
implements DuplexChannel

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class AbstractEpollChannel

AbstractEpollChannel.AbstractEpollUnsafe

Nested classes/interfaces inherited from class AbstractChannel

AbstractChannel.AbstractUnsafe

Nested classes/interfaces inherited from interface Channel

Channel.Unsafe

Field Summary

Fields

Modifier and Type	Field	Description
private WritableByteChannel	byteChannel
private static final String	EXPECTED_TYPES
private final Runnable	flushTask
private static final InternalLogger	logger
private static final ChannelMetadata	METADATA
private FileDescriptor	pipeIn
private FileDescriptor	pipeOut
private Queue<AbstractEpollStreamChannel.SpliceInTask>	spliceQueue

Fields inherited from class AbstractEpollChannel

active, epollInReadyRunnablePending, flags, inputClosedSeenErrorOnRead, socket

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractEpollStreamChannel(int fd)
protected	AbstractEpollStreamChannel(Channel parent, int fd)
(package private)	AbstractEpollStreamChannel(Channel parent, LinuxSocket fd)
protected	AbstractEpollStreamChannel(Channel parent, LinuxSocket fd, SocketAddress remote)
(package private)	AbstractEpollStreamChannel(LinuxSocket fd)
protected	AbstractEpollStreamChannel(LinuxSocket fd, boolean active)

Method Summary

Modifier and Type	Method	Description
private void	addToSpliceQueue(AbstractEpollStreamChannel.SpliceInTask task)
private void	adjustMaxBytesPerGatheringWrite(long attempted, long written, long oldMaxBytesPerGatheringWrite)
private void	clearSpliceQueue(ClosedChannelException exception)
protected void	doClose()	Close the Channel
protected final void	doShutdownOutput()	Called when conditions justify shutting down the output portion of the channel.
protected void	doWrite(ChannelOutboundBuffer in)	Flush the content of the given buffer to the remote peer.
private int	doWriteMultiple(ChannelOutboundBuffer in)	Attempt to write multiple ByteBuf objects.
protected int	doWriteSingle(ChannelOutboundBuffer in)	Attempt to write a single object.
private void	failSpliceIfClosed(ChannelPromise promise)
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	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 static void	shutdownDone(ChannelFuture shutdownOutputFuture, ChannelFuture shutdownInputFuture, 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	shutdownOutputDone(ChannelFuture shutdownOutputFuture, ChannelPromise promise)
final ChannelFuture	spliceTo(AbstractEpollStreamChannel ch, int len)	Deprecated. Will be removed in the future.
final ChannelFuture	spliceTo(AbstractEpollStreamChannel ch, int len, ChannelPromise promise)	Deprecated. will be removed in the future.
final ChannelFuture	spliceTo(FileDescriptor ch, int offset, int len)	Deprecated. Will be removed in the future.
final ChannelFuture	spliceTo(FileDescriptor ch, int offset, int len, ChannelPromise promise)	Deprecated. Will be removed in the future.
private int	writeBytes(ChannelOutboundBuffer in, ByteBuf buf)	Write bytes form the given ByteBuf to the underlying Channel.
private int	writeBytesMultiple(ChannelOutboundBuffer in, IovArray array)	Write multiple bytes via IovArray.
private int	writeBytesMultiple(ChannelOutboundBuffer in, ByteBuffer[] nioBuffers, int nioBufferCnt, long expectedWrittenBytes, long maxBytesPerGatheringWrite)	Write multiple bytes via ByteBuffer array.
private int	writeDefaultFileRegion(ChannelOutboundBuffer in, DefaultFileRegion region)	Write a DefaultFileRegion
private int	writeFileRegion(ChannelOutboundBuffer in, FileRegion region)	Write a FileRegion

Methods inherited from class AbstractEpollChannel

checkResolvable, clearEpollIn, clearFlag, config, doBeginRead, doBind, doConnect, doConnect0, doDeregister, doDisconnect, doReadBytes, doRegister, doWriteBytes, doWriteOrSendBytes, fd, isActive, isCompatible, isFlagSet, isOpen, isSoErrorZero, localAddress0, newDirectBuffer, newDirectBuffer, remoteAddress0, resetCachedAddresses, setFlag, shouldBreakEpollInReady

Methods inherited from class 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, maxMessagesPerWrite, newChannelPipeline, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, remoteAddress, toString, unsafe, validateFileRegion, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from class DefaultAttributeMap

attr, hasAttr

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface AttributeMap

attr, hasAttr

Methods inherited from interface Channel

alloc, bytesBeforeUnwritable, bytesBeforeWritable, closeFuture, config, eventLoop, flush, id, isActive, isOpen, isRegistered, isWritable, localAddress, parent, pipeline, read, remoteAddress, unsafe

Methods inherited from interface 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 Comparable

compareTo

Field Details

METADATA

private static final ChannelMetadata METADATA

EXPECTED_TYPES

private static final String EXPECTED_TYPES

logger

private static final InternalLogger logger

flushTask

private final Runnable flushTask

spliceQueue

private volatile Queue<AbstractEpollStreamChannel.SpliceInTask> spliceQueue

pipeIn

private FileDescriptor pipeIn

pipeOut

private FileDescriptor pipeOut

byteChannel

private WritableByteChannel byteChannel

Constructor Details

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(Channel parent,
 LinuxSocket fd,
 SocketAddress remote)

AbstractEpollStreamChannel

protected AbstractEpollStreamChannel(LinuxSocket fd,
 boolean active)

Method Details

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

@Deprecated
public final ChannelFuture spliceTo(AbstractEpollStreamChannel ch,
 int len)

Deprecated.

Will be removed in the future.

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

@Deprecated
public final ChannelFuture spliceTo(AbstractEpollStreamChannel ch,
 int len,
 ChannelPromise promise)

Deprecated.

will be removed in the future.

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

@Deprecated
public final ChannelFuture spliceTo(FileDescriptor ch,
 int offset,
 int len)

Deprecated.

Will be removed in the future.

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

@Deprecated
public final ChannelFuture spliceTo(FileDescriptor ch,
 int offset,
 int len,
 ChannelPromise promise)

Deprecated.

Will be removed in the future.

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 int writeBytes(ChannelOutboundBuffer in,
 ByteBuf buf)
                throws Exception

Write bytes form the given ByteBuf to the underlying Channel.

Parameters:

in - the collection which contains objects to write.

buf - the ByteBuf from which the bytes should be written

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

adjustMaxBytesPerGatheringWrite

private void adjustMaxBytesPerGatheringWrite(long attempted,
 long written,
 long oldMaxBytesPerGatheringWrite)

writeBytesMultiple

private int writeBytesMultiple(ChannelOutboundBuffer in,
 IovArray array)
                        throws IOException

Write multiple bytes via IovArray.

Parameters:

in - the collection which contains objects to write.

array - The array which contains the content 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:

IOException - If an I/O exception occurs during write.

writeBytesMultiple

private int writeBytesMultiple(ChannelOutboundBuffer in,
 ByteBuffer[] nioBuffers,
 int nioBufferCnt,
 long expectedWrittenBytes,
 long maxBytesPerGatheringWrite)
                        throws IOException

Write multiple bytes via ByteBuffer array.

Parameters:

in - the collection which contains objects to write.

nioBuffers - The buffers to write.

nioBufferCnt - The number of buffers to write.

expectedWrittenBytes - The number of bytes we expect to write.

maxBytesPerGatheringWrite - The maximum number of bytes we should attempt 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:

IOException - If an I/O exception occurs during write.

writeDefaultFileRegion

private int writeDefaultFileRegion(ChannelOutboundBuffer in,
 DefaultFileRegion region)
                            throws Exception

Write a DefaultFileRegion

Parameters:

in - the collection which contains objects to write.

region - the DefaultFileRegion from which the bytes should be written

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

writeFileRegion

private int writeFileRegion(ChannelOutboundBuffer in,
 FileRegion region)
                     throws Exception

Write a FileRegion

Parameters:

in - the collection which contains objects to write.

region - the FileRegion from which the bytes should be written

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

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

doWriteSingle

protected int doWriteSingle(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.

doWriteMultiple

private int doWriteMultiple(ChannelOutboundBuffer in)
                     throws Exception

Attempt to write multiple ByteBuf objects.

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)

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

doShutdownOutput

protected final void doShutdownOutput()
                               throws Exception

Description copied from class: AbstractChannel

Called when conditions justify shutting down the output portion of the channel. This may happen if a write operation throws an exception.

Overrides:

doShutdownOutput in class AbstractChannel

Throws:

Exception

shutdownInput0

private void shutdownInput0(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.

shutdownOutputDone

private void shutdownOutputDone(ChannelFuture shutdownOutputFuture,
 ChannelPromise promise)

shutdownDone

private static void shutdownDone(ChannelFuture shutdownOutputFuture,
 ChannelFuture shutdownInputFuture,
 ChannelPromise promise)

doClose

protected void doClose()
                throws Exception

Description copied from class: AbstractChannel

Close the Channel

Overrides:

doClose in class AbstractEpollChannel

Throws:

Exception

clearSpliceQueue

private void clearSpliceQueue(ClosedChannelException exception)

safeClosePipe

private static void safeClosePipe(FileDescriptor fd)

addToSpliceQueue

private void addToSpliceQueue(AbstractEpollStreamChannel.SpliceInTask task)