Class AbstractHttp2StreamChannel
- All Implemented Interfaces:
Channel
,ChannelOutboundInvoker
,Http2StreamChannel
,AttributeMap
,Comparable<Channel>
- Direct Known Subclasses:
Http2MultiplexCodec.Http2MultiplexCodecStreamChannel
,Http2MultiplexHandler.Http2MultiplexHandlerStreamChannel
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static final class
Returns the flow-control size for DATA frames, and 9 for all other frames.private final class
private static final class
ChannelConfig
so that the high and low writebuffer watermarks can reflect the outbound flow control window, without having to create a newWriteBufferWaterMark
object whenever the flow control window changes.private static enum
The current status of the read-processing for aAbstractHttp2StreamChannel
.private static final class
Http2FrameStreamVisitor
that fires the user event for every active stream pipeline.Nested classes/interfaces inherited from interface io.netty.channel.Channel
Channel.Unsafe
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) static final Http2FrameStreamVisitor
(package private) static final Http2FrameStreamVisitor
private final ChannelId
private final ChannelPromise
private final AbstractHttp2StreamChannel.Http2StreamChannelConfig
private Runnable
private boolean
true
after the first HEADERS frame has been writtenprivate int
private static final InternalLogger
private static final ChannelMetadata
private static final int
Number of bytes to consider non-payload messages.private boolean
private final ChannelPipeline
private boolean
This variable represents if a read is in progress for the current channel or was requested.private boolean
(package private) static final Http2FrameStreamVisitor
private final Http2FrameCodec.DefaultHttp2FrameStream
private static final AtomicLongFieldUpdater
<AbstractHttp2StreamChannel> private long
private final AbstractHttp2StreamChannel.Http2ChannelUnsafe
private int
private static final AtomicIntegerFieldUpdater
<AbstractHttp2StreamChannel> private final ChannelFutureListener
(package private) static final Http2FrameStreamVisitor
-
Constructor Summary
ConstructorsConstructorDescriptionAbstractHttp2StreamChannel
(Http2FrameCodec.DefaultHttp2FrameStream stream, int id, ChannelHandler inboundHandler) -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract void
alloc()
Return the assignedByteBufAllocator
which will be used to allocateByteBuf
s.bind
(SocketAddress localAddress) Request to bind to the givenSocketAddress
and notify theChannelFuture
once the operation completes, either because the operation was successful or because of an error.bind
(SocketAddress localAddress, ChannelPromise promise) Request to bind to the givenSocketAddress
and notify theChannelFuture
once the operation completes, either because the operation was successful or because of an error.long
Get how many bytes can be written untilChannel.isWritable()
returnsfalse
.long
Get how many bytes must be drained from underlying buffers untilChannel.isWritable()
returnstrue
.close()
Request to close theChannel
and notify theChannelFuture
once the operation completes, either because the operation was successful or because of an error.close
(ChannelPromise promise) Request to close theChannel
and notify theChannelFuture
once the operation completes, either because the operation was successful or because of an error.Returns theChannelFuture
which will be notified when this channel is closed.(package private) void
(package private) final void
closeWithError
(Http2Error error) int
config()
Returns the configuration of this channel.connect
(SocketAddress remoteAddress) Request to connect to the givenSocketAddress
and notify theChannelFuture
once the operation completes, either because the operation was successful or because of an error.connect
(SocketAddress remoteAddress, ChannelPromise promise) Request to connect to the givenSocketAddress
and notify theChannelFuture
once the operation completes, either because the operation was successful or because of an error.connect
(SocketAddress remoteAddress, SocketAddress localAddress) Request to connect to the givenSocketAddress
while bind to the localAddress and notify theChannelFuture
once the operation completes, either because the operation was successful or because of an error.connect
(SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise) Request to connect to the givenSocketAddress
while bind to the localAddress and notify theChannelFuture
once the operation completes, either because the operation was successful or because of an error.private void
decrementPendingOutboundBytes
(long size, boolean invokeLater) Request to deregister from the previous assignedEventExecutor
and notify theChannelFuture
once the operation completes, either because the operation was successful or because of an error.deregister
(ChannelPromise promise) Request to deregister from the previous assignedEventExecutor
and notify theChannelFuture
once the operation completes, either because the operation was successful or because of an error.Request to disconnect from the remote peer and notify theChannelFuture
once the operation completes, either because the operation was successful or because of an error.disconnect
(ChannelPromise promise) Request to disconnect from the remote peer and notify theChannelFuture
once the operation completes, either because the operation was successful or because of an error.boolean
private void
fireChannelWritabilityChanged
(boolean invokeLater) (package private) void
fireChildRead
(Http2Frame frame) Receive a read message.(package private) void
flush()
Request to flush all pending messages via this ChannelOutboundInvoker.protected void
int
hashCode()
id()
Returns the globally unique identifier of thisChannel
.private void
incrementPendingOutboundBytes
(long size, boolean invokeLater) boolean
isActive()
Returntrue
if theChannel
is active and so connected.boolean
isOpen()
Returnstrue
if theChannel
is open and may get active laterprotected abstract boolean
boolean
boolean
Returnstrue
if and only if the I/O thread will perform the requested write operation immediately.Returns the local address where this channel is bound to.private void
metadata()
newFailedFuture
(Throwable cause) Create a newChannelFuture
which is marked as failed already.Return an newChannelProgressivePromise
Return a newChannelPromise
.Create a newChannelFuture
which is marked as succeeded already.parent()
Returns the parent of this channel.protected abstract ChannelHandlerContext
pipeline()
Return the assignedChannelPipeline
.read()
Request to Read data from theChannel
into the first inbound buffer, triggers anChannelInboundHandler.channelRead(ChannelHandlerContext, Object)
event if data was read, and triggers achannelReadComplete
event so the handler can decide to continue reading.Returns the remote address where this channel is connected to.private void
setUnwritable
(boolean invokeLater) private void
setWritable
(boolean invokeLater) stream()
Returns theHttp2FrameStream
that belongs to this channel.(package private) void
toString()
(package private) final void
unsafe()
Returns an internal-use-only object that provides unsafe operations.Return a special ChannelPromise which can be reused for different operations.private static void
windowUpdateFrameWriteComplete
(ChannelFuture future, Channel streamChannel) Request to write a message via thisChannelHandlerContext
through theChannelPipeline
.write
(Object msg, ChannelPromise promise) Request to write a message via thisChannelHandlerContext
through theChannelPipeline
.protected ChannelFuture
write0
(ChannelHandlerContext ctx, Object msg) writeAndFlush
(Object msg) Shortcut for callChannelOutboundInvoker.write(Object)
andChannelOutboundInvoker.flush()
.writeAndFlush
(Object msg, ChannelPromise promise) Shortcut for callChannelOutboundInvoker.write(Object, ChannelPromise)
andChannelOutboundInvoker.flush()
.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
-
Field Details
-
WRITABLE_VISITOR
-
CHANNEL_INPUT_SHUTDOWN_READ_COMPLETE_VISITOR
-
CHANNEL_OUTPUT_SHUTDOWN_EVENT_VISITOR
-
SSL_CLOSE_COMPLETION_EVENT_VISITOR
-
logger
-
METADATA
-
MIN_HTTP2_FRAME_SIZE
private static final int MIN_HTTP2_FRAME_SIZENumber of bytes to consider non-payload messages. 9 is arbitrary, but also the minimum size of an HTTP/2 frame. Primarily is non-zero.- See Also:
-
TOTAL_PENDING_SIZE_UPDATER
-
UNWRITABLE_UPDATER
-
windowUpdateFrameWriteListener
-
config
-
unsafe
-
channelId
-
pipeline
-
stream
-
closePromise
-
registered
private volatile boolean registered -
totalPendingSize
private volatile long totalPendingSize -
unwritable
private volatile int unwritable -
fireChannelWritabilityChangedTask
-
outboundClosed
private boolean outboundClosed -
flowControlledBytes
private int flowControlledBytes -
readStatus
This variable represents if a read is in progress for the current channel or was requested. Note that depending upon theRecvByteBufAllocator
behavior a read may extend beyond theAbstractHttp2StreamChannel.Http2ChannelUnsafe.beginRead()
method scope. TheAbstractHttp2StreamChannel.Http2ChannelUnsafe.beginRead()
loop may drain all pending data, and then if the parent channel is reading this channel may still accept frames. -
inboundBuffer
-
firstFrameWritten
private boolean firstFrameWrittentrue
after the first HEADERS frame has been written -
readCompletePending
private boolean readCompletePending
-
-
Constructor Details
-
AbstractHttp2StreamChannel
AbstractHttp2StreamChannel(Http2FrameCodec.DefaultHttp2FrameStream stream, int id, ChannelHandler inboundHandler)
-
-
Method Details
-
windowUpdateFrameWriteComplete
-
incrementPendingOutboundBytes
private void incrementPendingOutboundBytes(long size, boolean invokeLater) -
decrementPendingOutboundBytes
private void decrementPendingOutboundBytes(long size, boolean invokeLater) -
trySetWritable
final void trySetWritable() -
setWritable
private void setWritable(boolean invokeLater) -
setUnwritable
private void setUnwritable(boolean invokeLater) -
fireChannelWritabilityChanged
private void fireChannelWritabilityChanged(boolean invokeLater) -
stream
Description copied from interface:Http2StreamChannel
Returns theHttp2FrameStream
that belongs to this channel.- Specified by:
stream
in interfaceHttp2StreamChannel
-
closeOutbound
void closeOutbound() -
streamClosed
void streamClosed() -
metadata
Description copied from interface:Channel
-
config
Description copied from interface:Channel
Returns the configuration of this channel. -
isOpen
public boolean isOpen()Description copied from interface:Channel
Returnstrue
if theChannel
is open and may get active later -
isActive
public boolean isActive()Description copied from interface:Channel
Returntrue
if theChannel
is active and so connected. -
isWritable
public boolean isWritable()Description copied from interface:Channel
Returnstrue
if and only if the I/O thread will perform the requested write operation immediately. Any write requests made when this method returnsfalse
are queued until the I/O thread is ready to process the queued write requests.- Specified by:
isWritable
in interfaceChannel
-
id
Description copied from interface:Channel
Returns the globally unique identifier of thisChannel
. -
eventLoop
Description copied from interface:Channel
-
parent
Description copied from interface:Channel
Returns the parent of this channel. -
isRegistered
public boolean isRegistered()Description copied from interface:Channel
- Specified by:
isRegistered
in interfaceChannel
-
localAddress
Description copied from interface:Channel
Returns the local address where this channel is bound to. The returnedSocketAddress
is supposed to be down-cast into more concrete type such asInetSocketAddress
to retrieve the detailed information.- Specified by:
localAddress
in interfaceChannel
- Returns:
- the local address of this channel.
null
if this channel is not bound.
-
remoteAddress
Description copied from interface:Channel
Returns the remote address where this channel is connected to. The returnedSocketAddress
is supposed to be down-cast into more concrete type such asInetSocketAddress
to retrieve the detailed information.- Specified by:
remoteAddress
in interfaceChannel
- Returns:
- the remote address of this channel.
null
if this channel is not connected. If this channel is not connected but it can receive messages from arbitrary remote addresses (e.g.DatagramChannel
, useDefaultAddressedEnvelope.recipient()
to determine the origination of the received message as this method will returnnull
.
-
closeFuture
Description copied from interface:Channel
Returns theChannelFuture
which will be notified when this channel is closed. This method always returns the same future instance.- Specified by:
closeFuture
in interfaceChannel
-
bytesBeforeUnwritable
public long bytesBeforeUnwritable()Description copied from interface:Channel
Get how many bytes can be written untilChannel.isWritable()
returnsfalse
. This quantity will always be non-negative. IfChannel.isWritable()
isfalse
then 0.- Specified by:
bytesBeforeUnwritable
in interfaceChannel
-
bytesBeforeWritable
public long bytesBeforeWritable()Description copied from interface:Channel
Get how many bytes must be drained from underlying buffers untilChannel.isWritable()
returnstrue
. This quantity will always be non-negative. IfChannel.isWritable()
istrue
then 0.- Specified by:
bytesBeforeWritable
in interfaceChannel
-
unsafe
Description copied from interface:Channel
Returns an internal-use-only object that provides unsafe operations. -
pipeline
Description copied from interface:Channel
Return the assignedChannelPipeline
. -
alloc
Description copied from interface:Channel
Return the assignedByteBufAllocator
which will be used to allocateByteBuf
s. -
read
Description copied from interface:ChannelOutboundInvoker
Request to Read data from theChannel
into the first inbound buffer, triggers anChannelInboundHandler.channelRead(ChannelHandlerContext, Object)
event if data was read, and triggers achannelReadComplete
event so the handler can decide to continue reading. If there's a pending read operation already, this method does nothing.This will result in having the
ChannelOutboundHandler.read(ChannelHandlerContext)
method called of the nextChannelOutboundHandler
contained in theChannelPipeline
of theChannel
.- Specified by:
read
in interfaceChannel
- Specified by:
read
in interfaceChannelOutboundInvoker
-
flush
Description copied from interface:ChannelOutboundInvoker
Request to flush all pending messages via this ChannelOutboundInvoker.- Specified by:
flush
in interfaceChannel
- Specified by:
flush
in interfaceChannelOutboundInvoker
-
bind
Description copied from interface:ChannelOutboundInvoker
Request to bind to the givenSocketAddress
and notify theChannelFuture
once the operation completes, either because the operation was successful or because of an error.This will result in having the
ChannelOutboundHandler.bind(ChannelHandlerContext, SocketAddress, ChannelPromise)
method called of the nextChannelOutboundHandler
contained in theChannelPipeline
of theChannel
.- Specified by:
bind
in interfaceChannelOutboundInvoker
-
connect
Description copied from interface:ChannelOutboundInvoker
Request to connect to the givenSocketAddress
and notify theChannelFuture
once the operation completes, either because the operation was successful or because of an error.If the connection fails because of a connection timeout, the
ChannelFuture
will get failed with aConnectTimeoutException
. If it fails because of connection refused aConnectException
will be used.This will result in having the
ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise)
method called of the nextChannelOutboundHandler
contained in theChannelPipeline
of theChannel
.- Specified by:
connect
in interfaceChannelOutboundInvoker
-
connect
Description copied from interface:ChannelOutboundInvoker
Request to connect to the givenSocketAddress
while bind to the localAddress and notify theChannelFuture
once the operation completes, either because the operation was successful or because of an error.This will result in having the
ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise)
method called of the nextChannelOutboundHandler
contained in theChannelPipeline
of theChannel
.- Specified by:
connect
in interfaceChannelOutboundInvoker
-
disconnect
Description copied from interface:ChannelOutboundInvoker
Request to disconnect from the remote peer and notify theChannelFuture
once the operation completes, either because the operation was successful or because of an error.This will result in having the
ChannelOutboundHandler.disconnect(ChannelHandlerContext, ChannelPromise)
method called of the nextChannelOutboundHandler
contained in theChannelPipeline
of theChannel
.- Specified by:
disconnect
in interfaceChannelOutboundInvoker
-
close
Description copied from interface:ChannelOutboundInvoker
Request to close theChannel
and notify theChannelFuture
once the operation completes, either because the operation was successful or because of an error. After it is closed it is not possible to reuse it again.This will result in having the
ChannelOutboundHandler.close(ChannelHandlerContext, ChannelPromise)
method called of the nextChannelOutboundHandler
contained in theChannelPipeline
of theChannel
.- Specified by:
close
in interfaceChannelOutboundInvoker
-
deregister
Description copied from interface:ChannelOutboundInvoker
Request to deregister from the previous assignedEventExecutor
and notify theChannelFuture
once the operation completes, either because the operation was successful or because of an error.This will result in having the
ChannelOutboundHandler.deregister(ChannelHandlerContext, ChannelPromise)
method called of the nextChannelOutboundHandler
contained in theChannelPipeline
of theChannel
.- Specified by:
deregister
in interfaceChannelOutboundInvoker
-
bind
Description copied from interface:ChannelOutboundInvoker
Request to bind to the givenSocketAddress
and notify theChannelFuture
once the operation completes, either because the operation was successful or because of an error. The givenChannelPromise
will be notified.This will result in having the
ChannelOutboundHandler.bind(ChannelHandlerContext, SocketAddress, ChannelPromise)
method called of the nextChannelOutboundHandler
contained in theChannelPipeline
of theChannel
.- Specified by:
bind
in interfaceChannelOutboundInvoker
-
connect
Description copied from interface:ChannelOutboundInvoker
Request to connect to the givenSocketAddress
and notify theChannelFuture
once the operation completes, either because the operation was successful or because of an error. The givenChannelFuture
will be notified.If the connection fails because of a connection timeout, the
ChannelFuture
will get failed with aConnectTimeoutException
. If it fails because of connection refused aConnectException
will be used.This will result in having the
ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise)
method called of the nextChannelOutboundHandler
contained in theChannelPipeline
of theChannel
.- Specified by:
connect
in interfaceChannelOutboundInvoker
-
connect
public ChannelFuture connect(SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise) Description copied from interface:ChannelOutboundInvoker
Request to connect to the givenSocketAddress
while bind to the localAddress and notify theChannelFuture
once the operation completes, either because the operation was successful or because of an error. The givenChannelPromise
will be notified and also returned.This will result in having the
ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise)
method called of the nextChannelOutboundHandler
contained in theChannelPipeline
of theChannel
.- Specified by:
connect
in interfaceChannelOutboundInvoker
-
disconnect
Description copied from interface:ChannelOutboundInvoker
Request to disconnect from the remote peer and notify theChannelFuture
once the operation completes, either because the operation was successful or because of an error. The givenChannelPromise
will be notified.This will result in having the
ChannelOutboundHandler.disconnect(ChannelHandlerContext, ChannelPromise)
method called of the nextChannelOutboundHandler
contained in theChannelPipeline
of theChannel
.- Specified by:
disconnect
in interfaceChannelOutboundInvoker
-
close
Description copied from interface:ChannelOutboundInvoker
Request to close theChannel
and notify theChannelFuture
once the operation completes, either because the operation was successful or because of an error. After it is closed it is not possible to reuse it again. The givenChannelPromise
will be notified.This will result in having the
ChannelOutboundHandler.close(ChannelHandlerContext, ChannelPromise)
method called of the nextChannelOutboundHandler
contained in theChannelPipeline
of theChannel
.- Specified by:
close
in interfaceChannelOutboundInvoker
-
deregister
Description copied from interface:ChannelOutboundInvoker
Request to deregister from the previous assignedEventExecutor
and notify theChannelFuture
once the operation completes, either because the operation was successful or because of an error. The givenChannelPromise
will be notified.This will result in having the
ChannelOutboundHandler.deregister(ChannelHandlerContext, ChannelPromise)
method called of the nextChannelOutboundHandler
contained in theChannelPipeline
of theChannel
.- Specified by:
deregister
in interfaceChannelOutboundInvoker
-
write
Description copied from interface:ChannelOutboundInvoker
Request to write a message via thisChannelHandlerContext
through theChannelPipeline
. This method will not request to actual flush, so be sure to callChannelOutboundInvoker.flush()
once you want to request to flush all pending data to the actual transport.- Specified by:
write
in interfaceChannelOutboundInvoker
-
write
Description copied from interface:ChannelOutboundInvoker
Request to write a message via thisChannelHandlerContext
through theChannelPipeline
. This method will not request to actual flush, so be sure to callChannelOutboundInvoker.flush()
once you want to request to flush all pending data to the actual transport.- Specified by:
write
in interfaceChannelOutboundInvoker
-
writeAndFlush
Description copied from interface:ChannelOutboundInvoker
Shortcut for callChannelOutboundInvoker.write(Object, ChannelPromise)
andChannelOutboundInvoker.flush()
.- Specified by:
writeAndFlush
in interfaceChannelOutboundInvoker
-
writeAndFlush
Description copied from interface:ChannelOutboundInvoker
Shortcut for callChannelOutboundInvoker.write(Object)
andChannelOutboundInvoker.flush()
.- Specified by:
writeAndFlush
in interfaceChannelOutboundInvoker
-
newPromise
Description copied from interface:ChannelOutboundInvoker
Return a newChannelPromise
.- Specified by:
newPromise
in interfaceChannelOutboundInvoker
-
newProgressivePromise
Description copied from interface:ChannelOutboundInvoker
Return an newChannelProgressivePromise
- Specified by:
newProgressivePromise
in interfaceChannelOutboundInvoker
-
newSucceededFuture
Description copied from interface:ChannelOutboundInvoker
Create a newChannelFuture
which is marked as succeeded already. SoFuture.isSuccess()
will returntrue
. AllFutureListener
added to it will be notified directly. Also every call of blocking methods will just return without blocking.- Specified by:
newSucceededFuture
in interfaceChannelOutboundInvoker
-
newFailedFuture
Description copied from interface:ChannelOutboundInvoker
Create a newChannelFuture
which is marked as failed already. SoFuture.isSuccess()
will returnfalse
. AllFutureListener
added to it will be notified directly. Also every call of blocking methods will just return without blocking.- Specified by:
newFailedFuture
in interfaceChannelOutboundInvoker
-
voidPromise
Description copied from interface:ChannelOutboundInvoker
Return a special ChannelPromise which can be reused for different operations.It's only supported to use it for
ChannelOutboundInvoker.write(Object, ChannelPromise)
.Be aware that the returned
Be aware this is an expert feature and should be used with care!ChannelPromise
will not support most operations and should only be used if you want to save an object allocation for every write operation. You will not be able to detect if the operation was complete, only if it failed as the implementation will callChannelPipeline.fireExceptionCaught(Throwable)
in this case.- Specified by:
voidPromise
in interfaceChannelOutboundInvoker
-
hashCode
public int hashCode() -
equals
-
compareTo
- Specified by:
compareTo
in interfaceComparable<Channel>
-
toString
-
fireChildRead
Receive a read message. This does not notify handlers unless a read is in progress on the channel. -
fireChildReadComplete
void fireChildReadComplete() -
closeWithError
-
maybeAddChannelToReadCompletePendingQueue
private void maybeAddChannelToReadCompletePendingQueue() -
flush0
-
write0
-
isParentReadInProgress
protected abstract boolean isParentReadInProgress() -
addChannelToReadCompletePendingQueue
protected abstract void addChannelToReadCompletePendingQueue() -
parentContext
-