Interface Http2FlowController
- All Known Subinterfaces:
Http2LocalFlowController
,Http2RemoteFlowController
- All Known Implementing Classes:
DefaultHttp2LocalFlowController
,DefaultHttp2RemoteFlowController
,DelegatingDecompressorFrameListener.ConsumedBytesConverter
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Set theChannelHandlerContext
for which to apply flow control on.void
incrementWindowSize
(Http2Stream stream, int delta) Increments the size of the stream's flow control window by the given delta.int
Gets the connection-wide initial flow control window size that is used as the basis for new stream flow control windows.void
initialWindowSize
(int newWindowSize) Sets the connection-wide initial flow control window and updates all stream windows (but not the connection stream window) by the delta.int
windowSize
(Http2Stream stream) Get the portion of the flow control window for the given stream that is currently available for sending/receiving frames which are subject to flow control.
-
Method Details
-
channelHandlerContext
Set theChannelHandlerContext
for which to apply flow control on.This must be called to properly initialize the
Http2FlowController
. Not calling this is considered a programming error.- Parameters:
ctx
- TheChannelHandlerContext
for which to apply flow control on.- Throws:
Http2Exception
- if any protocol-related error occurred.
-
initialWindowSize
Sets the connection-wide initial flow control window and updates all stream windows (but not the connection stream window) by the delta.Represents the value for SETTINGS_INITIAL_WINDOW_SIZE. This method should only be called by Netty (not users) as a result of a receiving a
SETTINGS
frame.- Parameters:
newWindowSize
- the new initial window size.- Throws:
Http2Exception
- thrown if any protocol-related error occurred.
-
initialWindowSize
int initialWindowSize()Gets the connection-wide initial flow control window size that is used as the basis for new stream flow control windows.Represents the value for SETTINGS_INITIAL_WINDOW_SIZE. The initial value returned by this method must be
Http2CodecUtil.DEFAULT_WINDOW_SIZE
. -
windowSize
Get the portion of the flow control window for the given stream that is currently available for sending/receiving frames which are subject to flow control. This quantity is measured in number of bytes. -
incrementWindowSize
Increments the size of the stream's flow control window by the given delta.In the case of a
Http2RemoteFlowController
this is called upon receipt of aWINDOW_UPDATE
frame from the remote endpoint to mirror the changes to the window size.For a
Http2LocalFlowController
this can be called to request the expansion of the window size published by this endpoint. It is up to the implementation, however, as to when aWINDOW_UPDATE
is actually sent.- Parameters:
stream
- The subject stream. UseHttp2Connection.connectionStream()
for requesting the size of the connection window.delta
- the change in size of the flow control window.- Throws:
Http2Exception
- thrown if a protocol-related error occurred.
-