Package io.netty.channel.epoll
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,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 Description private classAbstractEpollStreamChannel.EpollSocketWritableByteChannel(package private) classAbstractEpollStreamChannel.EpollStreamUnsafeprivate classAbstractEpollStreamChannel.SpliceFdTaskprivate classAbstractEpollStreamChannel.SpliceInChannelTaskprotected classAbstractEpollStreamChannel.SpliceInTaskprivate classAbstractEpollStreamChannel.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 Description private java.nio.channels.WritableByteChannelbyteChannelprivate static java.lang.StringEXPECTED_TYPESprivate java.lang.RunnableflushTaskprivate static InternalLoggerloggerprivate static ChannelMetadataMETADATAprivate FileDescriptorpipeInprivate FileDescriptorpipeOutprivate 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 Description protectedAbstractEpollStreamChannel(int fd)protectedAbstractEpollStreamChannel(Channel parent, int fd)(package private)AbstractEpollStreamChannel(Channel parent, LinuxSocket fd)protectedAbstractEpollStreamChannel(Channel parent, LinuxSocket fd, java.net.SocketAddress remote)(package private)AbstractEpollStreamChannel(LinuxSocket fd)protectedAbstractEpollStreamChannel(LinuxSocket fd, boolean active)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description private voidaddToSpliceQueue(AbstractEpollStreamChannel.SpliceInTask task)private voidadjustMaxBytesPerGatheringWrite(long attempted, long written, long oldMaxBytesPerGatheringWrite)private voidclearSpliceQueue(java.nio.channels.ClosedChannelException exception)protected voiddoClose()Close theChannelprotected voiddoShutdownOutput()Called when conditions justify shutting down the output portion of the channel.protected voiddoWrite(ChannelOutboundBuffer in)Flush the content of the given buffer to the remote peer.private intdoWriteMultiple(ChannelOutboundBuffer in)Attempt to write multipleByteBufobjects.protected intdoWriteSingle(ChannelOutboundBuffer in)Attempt to write a single object.private voidfailSpliceIfClosed(ChannelPromise promise)protected java.lang.ObjectfilterOutboundMessage(java.lang.Object msg)Invoked when a new message is added to aChannelOutboundBufferof thisAbstractChannel, so that theChannelimplementation converts the message to another.booleanisInputShutdown()Returnstrueif and only if the remote peer shut down its output so that no more data is received from this channel.booleanisOutputShutdown()booleanisShutdown()Determine if both the input and output of this channel have been shutdown.ChannelMetadatametadata()protected AbstractEpollChannel.AbstractEpollUnsafenewUnsafe()Create a newAbstractChannel.AbstractUnsafeinstance which will be used for the life-time of theChannelprivate static voidsafeClosePipe(FileDescriptor fd)ChannelFutureshutdown()Will shutdown the input and output sides of this channel.ChannelFutureshutdown(ChannelPromise promise)Will shutdown the input and output sides of this channel.private static voidshutdownDone(ChannelFuture shutdownOutputFuture, ChannelFuture shutdownInputFuture, ChannelPromise promise)ChannelFutureshutdownInput()ChannelFutureshutdownInput(ChannelPromise promise)Will shutdown the input and notifyChannelPromise.private voidshutdownInput0(ChannelPromise promise)ChannelFutureshutdownOutput()ChannelFutureshutdownOutput(ChannelPromise promise)Will shutdown the output and notifyChannelPromise.private voidshutdownOutputDone(ChannelFuture shutdownOutputFuture, ChannelPromise promise)ChannelFuturespliceTo(AbstractEpollStreamChannel ch, int len)Deprecated.Will be removed in the future.ChannelFuturespliceTo(AbstractEpollStreamChannel ch, int len, ChannelPromise promise)Deprecated.will be removed in the future.ChannelFuturespliceTo(FileDescriptor ch, int offset, int len)Deprecated.Will be removed in the future.ChannelFuturespliceTo(FileDescriptor ch, int offset, int len, ChannelPromise promise)Deprecated.Will be removed in the future.private intwriteBytes(ChannelOutboundBuffer in, ByteBuf buf)Write bytes form the givenByteBufto the underlyingChannel.private intwriteBytesMultiple(ChannelOutboundBuffer in, IovArray array)Write multiple bytes viaIovArray.private intwriteBytesMultiple(ChannelOutboundBuffer in, java.nio.ByteBuffer[] nioBuffers, int nioBufferCnt, long expectedWrittenBytes, long maxBytesPerGatheringWrite)Write multiple bytes viaByteBufferarray.private intwriteDefaultFileRegion(ChannelOutboundBuffer in, DefaultFileRegion region)Write aDefaultFileRegionprivate intwriteFileRegion(ChannelOutboundBuffer in, FileRegion region)Write aFileRegion-
Methods inherited from class io.netty.channel.epoll.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 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, 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.util.AttributeMap
attr, hasAttr
-
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.channel.ChannelOutboundInvoker
bind, bind, close, close, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, voidPromise, write, write, writeAndFlush, writeAndFlush
-
-
-
-
Field Detail
-
METADATA
private static final ChannelMetadata METADATA
-
EXPECTED_TYPES
private static final java.lang.String EXPECTED_TYPES
-
logger
private static final InternalLogger logger
-
flushTask
private final java.lang.Runnable flushTask
-
spliceQueue
private volatile 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(Channel parent, LinuxSocket fd, java.net.SocketAddress remote)
-
AbstractEpollStreamChannel
protected AbstractEpollStreamChannel(LinuxSocket fd, boolean active)
-
-
Method Detail
-
newUnsafe
protected AbstractEpollChannel.AbstractEpollUnsafe newUnsafe()
Description copied from class:AbstractChannelCreate a newAbstractChannel.AbstractUnsafeinstance which will be used for the life-time of theChannel- Specified by:
newUnsafein classAbstractEpollChannel
-
metadata
public ChannelMetadata metadata()
Description copied from interface:Channel- Specified by:
metadatain interfaceChannel- Overrides:
metadatain classAbstractEpollChannel
-
spliceTo
@Deprecated public final ChannelFuture spliceTo(AbstractEpollStreamChannel ch, int len)
Deprecated.Will be removed in the future.Splice from thisAbstractEpollStreamChannelto anotherAbstractEpollStreamChannel. Thelenis the number of bytes to splice. If usingInteger.MAX_VALUEit will splice until theChannelFuturewas canceled or it was failed. Please note:- both channels need to be registered to the same
EventLoop, otherwise anIllegalArgumentExceptionis thrown. EpollChannelConfig.getEpollMode()must beEpollMode.LEVEL_TRIGGEREDfor this and the targetAbstractEpollStreamChannel
- both channels need to be registered to the same
-
spliceTo
@Deprecated public final ChannelFuture spliceTo(AbstractEpollStreamChannel ch, int len, ChannelPromise promise)
Deprecated.will be removed in the future.Splice from thisAbstractEpollStreamChannelto anotherAbstractEpollStreamChannel. Thelenis the number of bytes to splice. If usingInteger.MAX_VALUEit will splice until theChannelFuturewas canceled or it was failed. Please note:- both channels need to be registered to the same
EventLoop, otherwise anIllegalArgumentExceptionis thrown. EpollChannelConfig.getEpollMode()must beEpollMode.LEVEL_TRIGGEREDfor this and the targetAbstractEpollStreamChannel
- both channels need to be registered to the same
-
spliceTo
@Deprecated public final ChannelFuture spliceTo(FileDescriptor ch, int offset, int len)
Deprecated.Will be removed in the future.Splice from thisAbstractEpollStreamChannelto anotherFileDescriptor. Theoffsetis the offset for theFileDescriptorandlenis the number of bytes to splice. If usingInteger.MAX_VALUEit will splice until theChannelFuturewas canceled or it was failed. Please note:EpollChannelConfig.getEpollMode()must beEpollMode.LEVEL_TRIGGEREDfor thisAbstractEpollStreamChannel- the
FileDescriptorwill not be closed after theChannelFutureis notified - this channel must be registered to an event loop or
IllegalStateExceptionwill 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 thisAbstractEpollStreamChannelto anotherFileDescriptor. Theoffsetis the offset for theFileDescriptorandlenis the number of bytes to splice. If usingInteger.MAX_VALUEit will splice until theChannelFuturewas canceled or it was failed. Please note:EpollChannelConfig.getEpollMode()must beEpollMode.LEVEL_TRIGGEREDfor thisAbstractEpollStreamChannel- the
FileDescriptorwill not be closed after theChannelPromiseis notified - this channel must be registered to an event loop or
IllegalStateExceptionwill be thrown.
-
failSpliceIfClosed
private void failSpliceIfClosed(ChannelPromise promise)
-
writeBytes
private int writeBytes(ChannelOutboundBuffer in, ByteBuf buf) throws java.lang.Exception
Write bytes form the givenByteBufto the underlyingChannel.- Parameters:
in- the collection which contains objects to write.buf- theByteBuffrom 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
- 0 - if no write was attempted. This is appropriate if an empty
- Throws:
java.lang.Exception
-
adjustMaxBytesPerGatheringWrite
private void adjustMaxBytesPerGatheringWrite(long attempted, long written, long oldMaxBytesPerGatheringWrite)
-
writeBytesMultiple
private int writeBytesMultiple(ChannelOutboundBuffer in, IovArray array) throws java.io.IOException
Write multiple bytes viaIovArray.- 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
- 0 - if no write was attempted. This is appropriate if an empty
- Throws:
java.io.IOException- If an I/O exception occurs during write.
-
writeBytesMultiple
private int writeBytesMultiple(ChannelOutboundBuffer in, java.nio.ByteBuffer[] nioBuffers, int nioBufferCnt, long expectedWrittenBytes, long maxBytesPerGatheringWrite) throws java.io.IOException
Write multiple bytes viaByteBufferarray.- 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
- 0 - if no write was attempted. This is appropriate if an empty
- Throws:
java.io.IOException- If an I/O exception occurs during write.
-
writeDefaultFileRegion
private int writeDefaultFileRegion(ChannelOutboundBuffer in, DefaultFileRegion region) throws java.lang.Exception
Write aDefaultFileRegion- Parameters:
in- the collection which contains objects to write.region- theDefaultFileRegionfrom 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
- 0 - if no write was attempted. This is appropriate if an empty
- Throws:
java.lang.Exception
-
writeFileRegion
private int writeFileRegion(ChannelOutboundBuffer in, FileRegion region) throws java.lang.Exception
Write aFileRegion- Parameters:
in- the collection which contains objects to write.region- theFileRegionfrom 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
- 0 - if no write was attempted. This is appropriate if an empty
- Throws:
java.lang.Exception
-
doWrite
protected void doWrite(ChannelOutboundBuffer in) throws java.lang.Exception
Description copied from class:AbstractChannelFlush the content of the given buffer to the remote peer.- Specified by:
doWritein classAbstractChannel- Throws:
java.lang.Exception
-
doWriteSingle
protected int doWriteSingle(ChannelOutboundBuffer in) throws java.lang.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
- 0 - if no write was attempted. This is appropriate if an empty
- Throws:
java.lang.Exception- If an I/O error occurs.
-
doWriteMultiple
private int doWriteMultiple(ChannelOutboundBuffer in) throws java.lang.Exception
Attempt to write multipleByteBufobjects.- 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
- 0 - if no write was attempted. This is appropriate if an empty
- Throws:
java.lang.Exception- If an I/O error occurs.
-
filterOutboundMessage
protected java.lang.Object filterOutboundMessage(java.lang.Object msg)
Description copied from class:AbstractChannelInvoked when a new message is added to aChannelOutboundBufferof thisAbstractChannel, so that theChannelimplementation converts the message to another. (e.g. heap buffer -> direct buffer)- Overrides:
filterOutboundMessagein classAbstractChannel
-
doShutdownOutput
protected final void doShutdownOutput() throws java.lang.ExceptionDescription copied from class:AbstractChannelCalled when conditions justify shutting down the output portion of the channel. This may happen if a write operation throws an exception.- Overrides:
doShutdownOutputin classAbstractChannel- Throws:
java.lang.Exception
-
shutdownInput0
private void shutdownInput0(ChannelPromise promise)
-
isOutputShutdown
public boolean isOutputShutdown()
- Specified by:
isOutputShutdownin interfaceDuplexChannel- See Also:
Socket.isOutputShutdown()
-
isInputShutdown
public boolean isInputShutdown()
Description copied from interface:DuplexChannelReturnstrueif 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 ofSocket.shutdownInput()andSocket.isInputShutdown().- Specified by:
isInputShutdownin interfaceDuplexChannel
-
isShutdown
public boolean isShutdown()
Description copied from interface:DuplexChannelDetermine if both the input and output of this channel have been shutdown.- Specified by:
isShutdownin interfaceDuplexChannel
-
shutdownOutput
public ChannelFuture shutdownOutput()
- Specified by:
shutdownOutputin interfaceDuplexChannel- See Also:
Socket.shutdownOutput()
-
shutdownOutput
public ChannelFuture shutdownOutput(ChannelPromise promise)
Description copied from interface:DuplexChannelWill shutdown the output and notifyChannelPromise.- Specified by:
shutdownOutputin interfaceDuplexChannel- See Also:
Socket.shutdownOutput()
-
shutdownInput
public ChannelFuture shutdownInput()
- Specified by:
shutdownInputin interfaceDuplexChannel- See Also:
Socket.shutdownInput()
-
shutdownInput
public ChannelFuture shutdownInput(ChannelPromise promise)
Description copied from interface:DuplexChannelWill shutdown the input and notifyChannelPromise.- Specified by:
shutdownInputin interfaceDuplexChannel- See Also:
Socket.shutdownInput()
-
shutdown
public ChannelFuture shutdown()
Description copied from interface:DuplexChannelWill shutdown the input and output sides of this channel.- Specified by:
shutdownin interfaceDuplexChannel- Returns:
- will be completed when both shutdown operations complete.
-
shutdown
public ChannelFuture shutdown(ChannelPromise promise)
Description copied from interface:DuplexChannelWill shutdown the input and output sides of this channel.- Specified by:
shutdownin interfaceDuplexChannel- 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 java.lang.ExceptionDescription copied from class:AbstractChannelClose theChannel- Overrides:
doClosein classAbstractEpollChannel- Throws:
java.lang.Exception
-
clearSpliceQueue
private void clearSpliceQueue(java.nio.channels.ClosedChannelException exception)
-
safeClosePipe
private static void safeClosePipe(FileDescriptor fd)
-
addToSpliceQueue
private void addToSpliceQueue(AbstractEpollStreamChannel.SpliceInTask task)
-
-