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 classReturns the flow-control size for DATA frames, and 9 for all other frames.private final classprivate static final classChannelConfigso that the high and low writebuffer watermarks can reflect the outbound flow control window, without having to create a newWriteBufferWaterMarkobject whenever the flow control window changes.private static enumThe current status of the read-processing for aAbstractHttp2StreamChannel.private static final classHttp2FrameStreamVisitorthat 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 Http2FrameStreamVisitorprivate final Http2StreamChannelIdprivate final ChannelPromiseprivate final AbstractHttp2StreamChannel.Http2StreamChannelConfigprivate Runnableprivate booleantrueafter the first HEADERS frame has been writtenprivate intprivate static final InternalLoggerprivate static final ChannelMetadataprivate static final intNumber of bytes to consider non-payload messages.private booleanprivate final ChannelPipelineprivate booleanThis variable represents if a read is in progress for the current channel or was requested.private boolean(package private) static final Http2FrameStreamVisitorprivate final Http2FrameCodec.DefaultHttp2FrameStreamprivate static final AtomicLongFieldUpdater<AbstractHttp2StreamChannel> private longprivate final AbstractHttp2StreamChannel.Http2ChannelUnsafeprivate intprivate 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 voidalloc()Return the assignedByteBufAllocatorwhich will be used to allocateByteBufs.bind(SocketAddress localAddress) Request to bind to the givenSocketAddressand notify theChannelFutureonce the operation completes, either because the operation was successful or because of an error.bind(SocketAddress localAddress, ChannelPromise promise) Request to bind to the givenSocketAddressand notify theChannelFutureonce the operation completes, either because the operation was successful or because of an error.longGet how many bytes can be written untilChannel.isWritable()returnsfalse.longGet how many bytes must be drained from underlying buffers untilChannel.isWritable()returnstrue.close()Request to close theChanneland notify theChannelFutureonce the operation completes, either because the operation was successful or because of an error.close(ChannelPromise promise) Request to close theChanneland notify theChannelFutureonce the operation completes, either because the operation was successful or because of an error.Returns theChannelFuturewhich will be notified when this channel is closed.(package private) void(package private) final voidcloseWithError(Http2Error error) intconfig()Returns the configuration of this channel.connect(SocketAddress remoteAddress) Request to connect to the givenSocketAddressand notify theChannelFutureonce the operation completes, either because the operation was successful or because of an error.connect(SocketAddress remoteAddress, ChannelPromise promise) Request to connect to the givenSocketAddressand notify theChannelFutureonce the operation completes, either because the operation was successful or because of an error.connect(SocketAddress remoteAddress, SocketAddress localAddress) Request to connect to the givenSocketAddresswhile bind to the localAddress and notify theChannelFutureonce 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 givenSocketAddresswhile bind to the localAddress and notify theChannelFutureonce the operation completes, either because the operation was successful or because of an error.private voiddecrementPendingOutboundBytes(long size, boolean invokeLater) Request to deregister from the previous assignedEventExecutorand notify theChannelFutureonce the operation completes, either because the operation was successful or because of an error.deregister(ChannelPromise promise) Request to deregister from the previous assignedEventExecutorand notify theChannelFutureonce the operation completes, either because the operation was successful or because of an error.Request to disconnect from the remote peer and notify theChannelFutureonce 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 theChannelFutureonce the operation completes, either because the operation was successful or because of an error.booleanprivate voidfireChannelWritabilityChanged(boolean invokeLater) (package private) voidfireChildRead(Http2Frame frame) Receive a read message.(package private) voidflush()Request to flush all pending messages via this ChannelOutboundInvoker.protected voidinthashCode()id()Returns the globally unique identifier of thisChannel.private voidincrementPendingOutboundBytes(long size, boolean invokeLater) booleanisActive()Returntrueif theChannelis active and so connected.booleanisOpen()Returnstrueif theChannelis open and may get active laterprotected abstract booleanbooleanbooleanReturnstrueif 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 voidmetadata()newFailedFuture(Throwable cause) Create a newChannelFuturewhich is marked as failed already.Return an newChannelProgressivePromiseReturn a newChannelPromise.Create a newChannelFuturewhich is marked as succeeded already.parent()Returns the parent of this channel.protected abstract ChannelHandlerContextpipeline()Return the assignedChannelPipeline.read()Request to Read data from theChannelinto the first inbound buffer, triggers anChannelInboundHandler.channelRead(ChannelHandlerContext, Object)event if data was read, and triggers achannelReadCompleteevent so the handler can decide to continue reading.Returns the remote address where this channel is connected to.private voidsetUnwritable(boolean invokeLater) private voidsetWritable(boolean invokeLater) stream()Returns theHttp2FrameStreamthat belongs to this channel.(package private) voidtoString()(package private) final voidunsafe()Returns an internal-use-only object that provides unsafe operations.Return a special ChannelPromise which can be reused for different operations.private static voidwindowUpdateFrameWriteComplete(ChannelFuture future, Channel streamChannel) Request to write a message via thisChannelHandlerContextthrough theChannelPipeline.write(Object msg, ChannelPromise promise) Request to write a message via thisChannelHandlerContextthrough theChannelPipeline.protected ChannelFuturewrite0(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, hasAttrMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods 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 theRecvByteBufAllocatorbehavior 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 firstFrameWrittentrueafter 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:Http2StreamChannelReturns theHttp2FrameStreamthat belongs to this channel.- Specified by:
streamin interfaceHttp2StreamChannel
-
closeOutbound
void closeOutbound() -
streamClosed
void streamClosed() -
metadata
Description copied from interface:Channel -
config
Description copied from interface:ChannelReturns the configuration of this channel. -
isOpen
public boolean isOpen()Description copied from interface:ChannelReturnstrueif theChannelis open and may get active later -
isActive
public boolean isActive()Description copied from interface:ChannelReturntrueif theChannelis active and so connected. -
isWritable
public boolean isWritable()Description copied from interface:ChannelReturnstrueif and only if the I/O thread will perform the requested write operation immediately. Any write requests made when this method returnsfalseare queued until the I/O thread is ready to process the queued write requests.WriteBufferWaterMarkcan be used to configure on which condition the write buffer would cause this channel to change writability.- Specified by:
isWritablein interfaceChannel
-
id
Description copied from interface:ChannelReturns the globally unique identifier of thisChannel. -
eventLoop
Description copied from interface:Channel -
parent
Description copied from interface:ChannelReturns the parent of this channel. -
isRegistered
public boolean isRegistered()Description copied from interface:Channel- Specified by:
isRegisteredin interfaceChannel
-
localAddress
Description copied from interface:ChannelReturns the local address where this channel is bound to. The returnedSocketAddressis supposed to be down-cast into more concrete type such asInetSocketAddressto retrieve the detailed information.- Specified by:
localAddressin interfaceChannel- Returns:
- the local address of this channel.
nullif this channel is not bound.
-
remoteAddress
Description copied from interface:ChannelReturns the remote address where this channel is connected to. The returnedSocketAddressis supposed to be down-cast into more concrete type such asInetSocketAddressto retrieve the detailed information.- Specified by:
remoteAddressin interfaceChannel- Returns:
- the remote address of this channel.
nullif 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:ChannelReturns theChannelFuturewhich will be notified when this channel is closed. This method always returns the same future instance.- Specified by:
closeFuturein interfaceChannel
-
bytesBeforeUnwritable
public long bytesBeforeUnwritable()Description copied from interface:ChannelGet how many bytes can be written untilChannel.isWritable()returnsfalse. This quantity will always be non-negative. IfChannel.isWritable()isfalsethen 0.WriteBufferWaterMarkcan be used to define writability settings.- Specified by:
bytesBeforeUnwritablein interfaceChannel
-
bytesBeforeWritable
public long bytesBeforeWritable()Description copied from interface:ChannelGet how many bytes must be drained from underlying buffers untilChannel.isWritable()returnstrue. This quantity will always be non-negative. IfChannel.isWritable()istruethen 0.WriteBufferWaterMarkcan be used to define writability settings.- Specified by:
bytesBeforeWritablein interfaceChannel
-
unsafe
Description copied from interface:ChannelReturns an internal-use-only object that provides unsafe operations. -
pipeline
Description copied from interface:ChannelReturn the assignedChannelPipeline. -
alloc
Description copied from interface:ChannelReturn the assignedByteBufAllocatorwhich will be used to allocateByteBufs. -
read
Description copied from interface:ChannelOutboundInvokerRequest to Read data from theChannelinto the first inbound buffer, triggers anChannelInboundHandler.channelRead(ChannelHandlerContext, Object)event if data was read, and triggers achannelReadCompleteevent 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 nextChannelOutboundHandlercontained in theChannelPipelineof theChannel.- Specified by:
readin interfaceChannel- Specified by:
readin interfaceChannelOutboundInvoker
-
flush
Description copied from interface:ChannelOutboundInvokerRequest to flush all pending messages via this ChannelOutboundInvoker.- Specified by:
flushin interfaceChannel- Specified by:
flushin interfaceChannelOutboundInvoker
-
bind
Description copied from interface:ChannelOutboundInvokerRequest to bind to the givenSocketAddressand notify theChannelFutureonce 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 nextChannelOutboundHandlercontained in theChannelPipelineof theChannel.- Specified by:
bindin interfaceChannelOutboundInvoker
-
connect
Description copied from interface:ChannelOutboundInvokerRequest to connect to the givenSocketAddressand notify theChannelFutureonce the operation completes, either because the operation was successful or because of an error.If the connection fails because of a connection timeout, the
ChannelFuturewill get failed with aConnectTimeoutException. If it fails because of connection refused aConnectExceptionwill be used.This will result in having the
ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise)method called of the nextChannelOutboundHandlercontained in theChannelPipelineof theChannel.- Specified by:
connectin interfaceChannelOutboundInvoker
-
connect
Description copied from interface:ChannelOutboundInvokerRequest to connect to the givenSocketAddresswhile bind to the localAddress and notify theChannelFutureonce 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 nextChannelOutboundHandlercontained in theChannelPipelineof theChannel.- Specified by:
connectin interfaceChannelOutboundInvoker
-
disconnect
Description copied from interface:ChannelOutboundInvokerRequest to disconnect from the remote peer and notify theChannelFutureonce 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 nextChannelOutboundHandlercontained in theChannelPipelineof theChannel.- Specified by:
disconnectin interfaceChannelOutboundInvoker
-
close
Description copied from interface:ChannelOutboundInvokerRequest to close theChanneland notify theChannelFutureonce 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 nextChannelOutboundHandlercontained in theChannelPipelineof theChannel.- Specified by:
closein interfaceChannelOutboundInvoker
-
deregister
Description copied from interface:ChannelOutboundInvokerRequest to deregister from the previous assignedEventExecutorand notify theChannelFutureonce 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 nextChannelOutboundHandlercontained in theChannelPipelineof theChannel.- Specified by:
deregisterin interfaceChannelOutboundInvoker
-
bind
Description copied from interface:ChannelOutboundInvokerRequest to bind to the givenSocketAddressand notify theChannelFutureonce the operation completes, either because the operation was successful or because of an error. The givenChannelPromisewill be notified.This will result in having the
ChannelOutboundHandler.bind(ChannelHandlerContext, SocketAddress, ChannelPromise)method called of the nextChannelOutboundHandlercontained in theChannelPipelineof theChannel.- Specified by:
bindin interfaceChannelOutboundInvoker
-
connect
Description copied from interface:ChannelOutboundInvokerRequest to connect to the givenSocketAddressand notify theChannelFutureonce the operation completes, either because the operation was successful or because of an error. The givenChannelFuturewill be notified.If the connection fails because of a connection timeout, the
ChannelFuturewill get failed with aConnectTimeoutException. If it fails because of connection refused aConnectExceptionwill be used.This will result in having the
ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise)method called of the nextChannelOutboundHandlercontained in theChannelPipelineof theChannel.- Specified by:
connectin interfaceChannelOutboundInvoker
-
connect
public ChannelFuture connect(SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise) Description copied from interface:ChannelOutboundInvokerRequest to connect to the givenSocketAddresswhile bind to the localAddress and notify theChannelFutureonce the operation completes, either because the operation was successful or because of an error. The givenChannelPromisewill be notified and also returned.This will result in having the
ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise)method called of the nextChannelOutboundHandlercontained in theChannelPipelineof theChannel.- Specified by:
connectin interfaceChannelOutboundInvoker
-
disconnect
Description copied from interface:ChannelOutboundInvokerRequest to disconnect from the remote peer and notify theChannelFutureonce the operation completes, either because the operation was successful or because of an error. The givenChannelPromisewill be notified.This will result in having the
ChannelOutboundHandler.disconnect(ChannelHandlerContext, ChannelPromise)method called of the nextChannelOutboundHandlercontained in theChannelPipelineof theChannel.- Specified by:
disconnectin interfaceChannelOutboundInvoker
-
close
Description copied from interface:ChannelOutboundInvokerRequest to close theChanneland notify theChannelFutureonce 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 givenChannelPromisewill be notified.This will result in having the
ChannelOutboundHandler.close(ChannelHandlerContext, ChannelPromise)method called of the nextChannelOutboundHandlercontained in theChannelPipelineof theChannel.- Specified by:
closein interfaceChannelOutboundInvoker
-
deregister
Description copied from interface:ChannelOutboundInvokerRequest to deregister from the previous assignedEventExecutorand notify theChannelFutureonce the operation completes, either because the operation was successful or because of an error. The givenChannelPromisewill be notified.This will result in having the
ChannelOutboundHandler.deregister(ChannelHandlerContext, ChannelPromise)method called of the nextChannelOutboundHandlercontained in theChannelPipelineof theChannel.- Specified by:
deregisterin interfaceChannelOutboundInvoker
-
write
Description copied from interface:ChannelOutboundInvokerRequest to write a message via thisChannelHandlerContextthrough 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:
writein interfaceChannelOutboundInvoker
-
write
Description copied from interface:ChannelOutboundInvokerRequest to write a message via thisChannelHandlerContextthrough 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:
writein interfaceChannelOutboundInvoker
-
writeAndFlush
Description copied from interface:ChannelOutboundInvokerShortcut for callChannelOutboundInvoker.write(Object, ChannelPromise)andChannelOutboundInvoker.flush().- Specified by:
writeAndFlushin interfaceChannelOutboundInvoker
-
writeAndFlush
Description copied from interface:ChannelOutboundInvokerShortcut for callChannelOutboundInvoker.write(Object)andChannelOutboundInvoker.flush().- Specified by:
writeAndFlushin interfaceChannelOutboundInvoker
-
newPromise
Description copied from interface:ChannelOutboundInvokerReturn a newChannelPromise.- Specified by:
newPromisein interfaceChannelOutboundInvoker
-
newProgressivePromise
Description copied from interface:ChannelOutboundInvokerReturn an newChannelProgressivePromise- Specified by:
newProgressivePromisein interfaceChannelOutboundInvoker
-
newSucceededFuture
Description copied from interface:ChannelOutboundInvokerCreate a newChannelFuturewhich is marked as succeeded already. SoFuture.isSuccess()will returntrue. AllFutureListeneradded to it will be notified directly. Also every call of blocking methods will just return without blocking.- Specified by:
newSucceededFuturein interfaceChannelOutboundInvoker
-
newFailedFuture
Description copied from interface:ChannelOutboundInvokerCreate a newChannelFuturewhich is marked as failed already. SoFuture.isSuccess()will returnfalse. AllFutureListeneradded to it will be notified directly. Also every call of blocking methods will just return without blocking.- Specified by:
newFailedFuturein interfaceChannelOutboundInvoker
-
voidPromise
Description copied from interface:ChannelOutboundInvokerReturn 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!ChannelPromisewill 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:
voidPromisein interfaceChannelOutboundInvoker
-
hashCode
public int hashCode() -
equals
-
compareTo
- Specified by:
compareToin 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
-