Modifier and Type	Class and Description
private class	DefaultHttp2LocalFlowController.AutoRefillState Flow control state that does autorefill of the flow control window when the data is received.
private class	DefaultHttp2LocalFlowController.DefaultState Flow control window state for an individual stream.
private static interface	DefaultHttp2LocalFlowController.FlowState An abstraction which provides specific extensions used by local flow control.
private class	DefaultHttp2LocalFlowController.WindowUpdateVisitor Provides a means to iterate over all active streams and increment the flow control windows.

Modifier and Type	Field and Description
private final Http2Connection	connection
private ChannelHandlerContext	ctx
public static final float	DEFAULT_WINDOW_UPDATE_RATIO The default ratio of window size to initial window size below which a `WINDOW_UPDATE` is sent to expand the window.
private Http2FrameWriter	frameWriter
private int	initialWindowSize
private static final DefaultHttp2LocalFlowController.FlowState	REDUCED_FLOW_STATE The local flow control state for a single stream that is not in a state where flow controlled frames cannot be exchanged.
private final Http2Connection.PropertyKey	stateKey
private float	windowUpdateRatio

Access	Constructor and Description
public	DefaultHttp2LocalFlowController(Http2Connection connection)
public	DefaultHttp2LocalFlowController(Http2Connection the connection state. connection, float the window percentage below which to send a `WINDOW_UPDATE`. windowUpdateRatio, boolean if `true`, effectively disables the connection window in the flow control algorithm as they will always refill automatically without requiring the application to consume the bytes. When enabled, the maximum bytes you must be prepared to queue is proportional to `maximum number of concurrent streams * the initial window size per stream` (SETTINGS_MAX_CONCURRENT_STREAMS SETTINGS_INITIAL_WINDOW_SIZE). autoRefillConnectionWindow) Constructs a controller with the given settings.

Method Summary

Modifier and Type	Method and Description
public void	channelHandlerContext(ChannelHandlerContext The `ChannelHandlerContext` for which to apply flow control on. ctx) Implements io.netty.handler.codec.http2.Http2FlowController.channelHandlerContext. Set the `ChannelHandlerContext` for which to apply flow control on.
private static void	checkValidRatio(float ratio)
private DefaultHttp2LocalFlowController.FlowState	connectionState()
private boolean	consumeAllBytes(DefaultHttp2LocalFlowController.FlowState state, int numBytes)
public boolean	consumeBytes(Http2Stream the stream for which window space should be freed. The connection stream object must not be used. If `stream` is `null` or closed (i.e. `Http2Stream#state()` method returns `Http2Stream.State#CLOSED`), calling this method has no effect. stream, int the number of bytes to be returned to the flow control window. numBytes) Implements io.netty.handler.codec.http2.Http2LocalFlowController.consumeBytes. Indicates that the application has consumed a number of bytes for the given stream and is therefore ready to receive more data from the remote endpoint.
public DefaultHttp2LocalFlowController	frameWriter(Http2FrameWriter the HTTP/2 frame writer. frameWriter) Implements io.netty.handler.codec.http2.Http2LocalFlowController.frameWriter. Sets the writer to be use for sending `WINDOW_UPDATE` frames.
public void	incrementWindowSize(Http2Stream The subject stream. Use `Http2Connection#connectionStream()` for requesting the size of the connection window. stream, int the change in size of the flow control window. delta) Implements io.netty.handler.codec.http2.Http2FlowController.incrementWindowSize. Increments the size of the stream's flow control window by the given delta.
public void	initialWindowSize(int the new initial window size. newWindowSize) Implements io.netty.handler.codec.http2.Http2FlowController.initialWindowSize. Sets the connection-wide initial flow control window and updates all stream windows (but not the connection stream window) by the delta.
public int	initialWindowSize() Implements io.netty.handler.codec.http2.Http2FlowController.initialWindowSize. Gets the connection-wide initial flow control window size that is used as the basis for new stream flow control windows.
public int	initialWindowSize(Http2Stream stream) Implements io.netty.handler.codec.http2.Http2LocalFlowController.initialWindowSize. Get the initial flow control window size for the given stream.
private static boolean	isClosed(Http2Stream stream)
public void	receiveFlowControlledFrame(Http2Stream the subject stream for the received frame. The connection stream object must not be used. If `stream` is `null` or closed, flow control should only be applied to the connection window and the bytes are immediately consumed. stream, ByteBuf payload buffer for the frame. data, int additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive). padding, boolean Indicates whether this is the last frame to be sent from the remote endpoint for this stream. endOfStream) Implements io.netty.handler.codec.http2.Http2LocalFlowController.receiveFlowControlledFrame. Receives an inbound `DATA` frame from the remote endpoint and applies flow control policies to it for both the `stream` as well as the connection.
private DefaultHttp2LocalFlowController.FlowState	state(Http2Stream stream)
public int	unconsumedBytes(Http2Stream the stream for which window space should be freed. stream) Implements io.netty.handler.codec.http2.Http2LocalFlowController.unconsumedBytes. The number of bytes for the given stream that have been received but not yet consumed by the application.
public int	windowSize(Http2Stream stream) Implements io.netty.handler.codec.http2.Http2FlowController.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.
public void	windowUpdateRatio(float the ratio to use when checking if a `WINDOW_UPDATE` is determined necessary for new streams. ratio) The window update ratio is used to determine when a window update must be sent.
public float	windowUpdateRatio() The window update ratio is used to determine when a window update must be sent.
public void	windowUpdateRatio(Http2Stream the stream for which `ratio` applies to. stream, float the ratio to use when checking if a `WINDOW_UPDATE` is determined necessary. ratio) The window update ratio is used to determine when a window update must be sent.
public float	windowUpdateRatio(Http2Stream stream) The window update ratio is used to determine when a window update must be sent.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

connection	back to summary
private final Http2Connection connection

ctx	back to summary
private ChannelHandlerContext ctx

DEFAULT_WINDOW_UPDATE_RATIO	back to summary
public static final float DEFAULT_WINDOW_UPDATE_RATIO The default ratio of window size to initial window size below which a `WINDOW_UPDATE` is sent to expand the window.

frameWriter	back to summary
private Http2FrameWriter frameWriter

initialWindowSize	back to summary
private int initialWindowSize

REDUCED_FLOW_STATE	back to summary
private static final DefaultHttp2LocalFlowController.FlowState REDUCED_FLOW_STATE The local flow control state for a single stream that is not in a state where flow controlled frames cannot be exchanged.

stateKey	back to summary
private final Http2Connection.PropertyKey stateKey

windowUpdateRatio	back to summary
private float windowUpdateRatio

Constructor Detail

DefaultHttp2LocalFlowController	back to summary
public DefaultHttp2LocalFlowController(Http2Connection connection)

DefaultHttp2LocalFlowController back to summary

DefaultHttp2LocalFlowController	back to summary
public DefaultHttp2LocalFlowController(Http2Connection connection, float windowUpdateRatio, boolean autoRefillConnectionWindow) Constructs a controller with the given settings. Parameters connection:Http2Connection the connection state. windowUpdateRatio:float the window percentage below which to send a `WINDOW_UPDATE`. autoRefillConnectionWindow:boolean if `true`, effectively disables the connection window in the flow control algorithm as they will always refill automatically without requiring the application to consume the bytes. When enabled, the maximum bytes you must be prepared to queue is proportional to `maximum number of concurrent streams * the initial window size per stream` (SETTINGS_MAX_CONCURRENT_STREAMS SETTINGS_INITIAL_WINDOW_SIZE).

public DefaultHttp2LocalFlowController(Http2Connection connection, float windowUpdateRatio, boolean autoRefillConnectionWindow)

Constructs a controller with the given settings.

Parameters

connection:Http2Connection: the connection state.
windowUpdateRatio:float: the window percentage below which to send a WINDOW_UPDATE.
autoRefillConnectionWindow:boolean: if true, effectively disables the connection window in the flow control algorithm as they will always refill automatically without requiring the application to consume the bytes. When enabled, the maximum bytes you must be prepared to queue is proportional to maximum number of concurrent streams * the initial window size per stream (SETTINGS_MAX_CONCURRENT_STREAMS SETTINGS_INITIAL_WINDOW_SIZE).

Method Detail

channelHandlerContext back to summary

channelHandlerContext	back to summary
public void channelHandlerContext(ChannelHandlerContext ctx) Implements io.netty.handler.codec.http2.Http2FlowController.channelHandlerContext. Doc from io.netty.handler.codec.http2.Http2FlowController.channelHandlerContext. Set the `ChannelHandlerContext` 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:ChannelHandlerContext The `ChannelHandlerContext` for which to apply flow control on. Annotations @Override

public void channelHandlerContext(ChannelHandlerContext ctx)

Implements io.netty.handler.codec.http2.Http2FlowController.channelHandlerContext.

Doc from io.netty.handler.codec.http2.Http2FlowController.channelHandlerContext.

Set the ChannelHandlerContext 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:ChannelHandlerContext: The ChannelHandlerContext for which to apply flow control on.

Annotations

@Override

checkValidRatio	back to summary
private static void checkValidRatio(float ratio)

connectionState	back to summary
private DefaultHttp2LocalFlowController.FlowState connectionState()

consumeAllBytes	back to summary
private boolean consumeAllBytes(DefaultHttp2LocalFlowController.FlowState state, int numBytes) throws Http2Exception

consumeBytes back to summary

consumeBytes	back to summary
public boolean consumeBytes(Http2Stream stream, int numBytes) throws Http2Exception Implements io.netty.handler.codec.http2.Http2LocalFlowController.consumeBytes. Doc from io.netty.handler.codec.http2.Http2LocalFlowController.consumeBytes. Indicates that the application has consumed a number of bytes for the given stream and is therefore ready to receive more data from the remote endpoint. The application must consume any bytes that it receives or the flow control window will collapse. Consuming bytes enables the flow controller to send `WINDOW_UPDATE` to restore a portion of the flow control window for the stream. If `stream` is `null` or closed (i.e. `Http2Stream#state()` method returns `Http2Stream.State#CLOSED`), calling this method has no effect. Parameters stream:Http2Stream the stream for which window space should be freed. The connection stream object must not be used. If `stream` is `null` or closed (i.e. `Http2Stream#state()` method returns `Http2Stream.State#CLOSED`), calling this method has no effect. numBytes:int the number of bytes to be returned to the flow control window. Returns:boolean true if a `WINDOW_UPDATE` was sent, false otherwise. Annotations @Override Exceptions Http2Exception: if the number of bytes returned exceeds the `unconsumedBytes(Http2Stream)` for the stream.

public boolean consumeBytes(Http2Stream stream, int numBytes) throws Http2Exception

Implements io.netty.handler.codec.http2.Http2LocalFlowController.consumeBytes.

Doc from io.netty.handler.codec.http2.Http2LocalFlowController.consumeBytes.

Indicates that the application has consumed a number of bytes for the given stream and is therefore ready to receive more data from the remote endpoint. The application must consume any bytes that it receives or the flow control window will collapse. Consuming bytes enables the flow controller to send WINDOW_UPDATE to restore a portion of the flow control window for the stream.

If stream is null or closed (i.e. Http2Stream#state() method returns Http2Stream.State#CLOSED), calling this method has no effect.

Parameters

stream:Http2Stream: the stream for which window space should be freed. The connection stream object must not be used. If stream is null or closed (i.e. Http2Stream#state() method returns Http2Stream.State#CLOSED), calling this method has no effect.
numBytes:int: the number of bytes to be returned to the flow control window.

Returns:boolean

true if a WINDOW_UPDATE was sent, false otherwise.

Annotations

@Override

Exceptions

Http2Exception:: if the number of bytes returned exceeds the unconsumedBytes(Http2Stream) for the stream.

frameWriter back to summary

frameWriter	back to summary
public DefaultHttp2LocalFlowController frameWriter(Http2FrameWriter frameWriter) Implements io.netty.handler.codec.http2.Http2LocalFlowController.frameWriter. Doc from io.netty.handler.codec.http2.Http2LocalFlowController.frameWriter. Sets the writer to be use for sending `WINDOW_UPDATE` frames. This must be called before any flow controlled data is received. Parameters frameWriter:Http2FrameWriter the HTTP/2 frame writer. Annotations @Override

public DefaultHttp2LocalFlowController frameWriter(Http2FrameWriter frameWriter)

Implements io.netty.handler.codec.http2.Http2LocalFlowController.frameWriter.

Doc from io.netty.handler.codec.http2.Http2LocalFlowController.frameWriter.

Sets the writer to be use for sending WINDOW_UPDATE frames. This must be called before any flow controlled data is received.

Parameters

frameWriter:Http2FrameWriter: the HTTP/2 frame writer.

Annotations

@Override

incrementWindowSize back to summary

incrementWindowSize	back to summary
public void incrementWindowSize(Http2Stream stream, int delta) throws Http2Exception Implements io.netty.handler.codec.http2.Http2FlowController.incrementWindowSize. Doc from io.netty.handler.codec.http2.Http2FlowController.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 a `WINDOW_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 a `WINDOW_UPDATE` is actually sent. Parameters stream:Http2Stream The subject stream. Use `Http2Connection#connectionStream()` for requesting the size of the connection window. delta:int the change in size of the flow control window. Annotations @Override Exceptions Http2Exception: thrown if a protocol-related error occurred.

public void incrementWindowSize(Http2Stream stream, int delta) throws Http2Exception

Implements io.netty.handler.codec.http2.Http2FlowController.incrementWindowSize.

Doc from io.netty.handler.codec.http2.Http2FlowController.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 a WINDOW_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 a WINDOW_UPDATE is actually sent.

Parameters

stream:Http2Stream: The subject stream. Use Http2Connection#connectionStream() for requesting the size of the connection window.
delta:int: the change in size of the flow control window.

Annotations

@Override

Exceptions

Http2Exception:: thrown if a protocol-related error occurred.

initialWindowSize back to summary

initialWindowSize	back to summary
public void initialWindowSize(int newWindowSize) throws Http2Exception Implements io.netty.handler.codec.http2.Http2FlowController.initialWindowSize. Doc from io.netty.handler.codec.http2.Http2FlowController.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:int the new initial window size. Annotations @Override Exceptions Http2Exception: thrown if any protocol-related error occurred.

public void initialWindowSize(int newWindowSize) throws Http2Exception

Implements io.netty.handler.codec.http2.Http2FlowController.initialWindowSize.

Doc from io.netty.handler.codec.http2.Http2FlowController.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:int: the new initial window size.

Annotations

@Override

Exceptions

Http2Exception:: thrown if any protocol-related error occurred.

initialWindowSize back to summary

initialWindowSize	back to summary
public int initialWindowSize() Implements io.netty.handler.codec.http2.Http2FlowController.initialWindowSize. Doc from io.netty.handler.codec.http2.Http2FlowController.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`. Annotations @Override

public int initialWindowSize()

Implements io.netty.handler.codec.http2.Http2FlowController.initialWindowSize.

Doc from io.netty.handler.codec.http2.Http2FlowController.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.

Annotations

@Override

initialWindowSize back to summary

initialWindowSize	back to summary
public int initialWindowSize(Http2Stream stream) Implements io.netty.handler.codec.http2.Http2LocalFlowController.initialWindowSize. Doc from io.netty.handler.codec.http2.Http2LocalFlowController.initialWindowSize. Get the initial flow control window size for the given stream. This quantity is measured in number of bytes. Note the unavailable window portion can be calculated by `initialWindowSize()` - `windowSize(Http2Stream)`. Annotations @Override

public int initialWindowSize(Http2Stream stream)

Implements io.netty.handler.codec.http2.Http2LocalFlowController.initialWindowSize.

Doc from io.netty.handler.codec.http2.Http2LocalFlowController.initialWindowSize.

Get the initial flow control window size for the given stream. This quantity is measured in number of bytes. Note the unavailable window portion can be calculated by initialWindowSize() - windowSize(Http2Stream).

Annotations

@Override

isClosed	back to summary
private static boolean isClosed(Http2Stream stream)

receiveFlowControlledFrame back to summary

receiveFlowControlledFrame	back to summary
public void receiveFlowControlledFrame(Http2Stream stream, ByteBuf data, int padding, boolean endOfStream) throws Http2Exception Implements io.netty.handler.codec.http2.Http2LocalFlowController.receiveFlowControlledFrame. Doc from io.netty.handler.codec.http2.Http2LocalFlowController.receiveFlowControlledFrame. Receives an inbound `DATA` frame from the remote endpoint and applies flow control policies to it for both the `stream` as well as the connection. If any flow control policies have been violated, an exception is raised immediately, otherwise the frame is considered to have "passed" flow control. If `stream` is `null` or closed, flow control should only be applied to the connection window and the bytes are immediately consumed. Parameters stream:Http2Stream the subject stream for the received frame. The connection stream object must not be used. If `stream` is `null` or closed, flow control should only be applied to the connection window and the bytes are immediately consumed. data:ByteBuf payload buffer for the frame. padding:int additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive). endOfStream:boolean Indicates whether this is the last frame to be sent from the remote endpoint for this stream. Annotations @Override Exceptions Http2Exception: if any flow control errors are encountered.

public void receiveFlowControlledFrame(Http2Stream stream, ByteBuf data, int padding, boolean endOfStream) throws Http2Exception

Implements io.netty.handler.codec.http2.Http2LocalFlowController.receiveFlowControlledFrame.

Doc from io.netty.handler.codec.http2.Http2LocalFlowController.receiveFlowControlledFrame.

Receives an inbound DATA frame from the remote endpoint and applies flow control policies to it for both the stream as well as the connection. If any flow control policies have been violated, an exception is raised immediately, otherwise the frame is considered to have "passed" flow control.

If stream is null or closed, flow control should only be applied to the connection window and the bytes are immediately consumed.

Parameters

stream:Http2Stream: the subject stream for the received frame. The connection stream object must not be used. If stream is null or closed, flow control should only be applied to the connection window and the bytes are immediately consumed.
data:ByteBuf: payload buffer for the frame.
padding:int: additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive).
endOfStream:boolean: Indicates whether this is the last frame to be sent from the remote endpoint for this stream.

Annotations

@Override

Exceptions

Http2Exception:: if any flow control errors are encountered.

state	back to summary
private DefaultHttp2LocalFlowController.FlowState state(Http2Stream stream)

unconsumedBytes	back to summary
public int unconsumedBytes(Http2Stream stream) Implements io.netty.handler.codec.http2.Http2LocalFlowController.unconsumedBytes. Doc from io.netty.handler.codec.http2.Http2LocalFlowController.unconsumedBytes. The number of bytes for the given stream that have been received but not yet consumed by the application. Parameters stream:Http2Stream the stream for which window space should be freed. Returns:int the number of unconsumed bytes for the stream. Annotations @Override

unconsumedBytes

back to summary

public int unconsumedBytes(Http2Stream stream)

Implements io.netty.handler.codec.http2.Http2LocalFlowController.unconsumedBytes.

Doc from io.netty.handler.codec.http2.Http2LocalFlowController.unconsumedBytes.

The number of bytes for the given stream that have been received but not yet consumed by the application.

Parameters

stream:Http2Stream: the stream for which window space should be freed.

Returns:int

the number of unconsumed bytes for the stream.

Annotations

@Override

windowSize	back to summary
public int windowSize(Http2Stream stream) Implements io.netty.handler.codec.http2.Http2FlowController.windowSize. Doc from io.netty.handler.codec.http2.Http2FlowController.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. Annotations @Override

windowSize

back to summary

public int windowSize(Http2Stream stream)

Implements io.netty.handler.codec.http2.Http2FlowController.windowSize.

Doc from io.netty.handler.codec.http2.Http2FlowController.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.

Annotations

@Override

windowUpdateRatio back to summary

windowUpdateRatio	back to summary
public void windowUpdateRatio(float ratio) The window update ratio is used to determine when a window update must be sent. If the ratio of bytes processed since the last update has meet or exceeded this ratio then a window update will be sent. This is the global window update ratio that will be used for new streams. Parameters ratio:float the ratio to use when checking if a `WINDOW_UPDATE` is determined necessary for new streams. Exceptions IllegalArgumentException: If the ratio is out of bounds (0, 1).

public void windowUpdateRatio(float ratio)

The window update ratio is used to determine when a window update must be sent. If the ratio of bytes processed since the last update has meet or exceeded this ratio then a window update will be sent. This is the global window update ratio that will be used for new streams.

Parameters

ratio:float: the ratio to use when checking if a WINDOW_UPDATE is determined necessary for new streams.

Exceptions

IllegalArgumentException:: If the ratio is out of bounds (0, 1).

windowUpdateRatio	back to summary
public float windowUpdateRatio() The window update ratio is used to determine when a window update must be sent. If the ratio of bytes processed since the last update has meet or exceeded this ratio then a window update will be sent. This is the global window update ratio that will be used for new streams.

windowUpdateRatio back to summary

windowUpdateRatio	back to summary
public void windowUpdateRatio(Http2Stream stream, float ratio) throws Http2Exception The window update ratio is used to determine when a window update must be sent. If the ratio of bytes processed since the last update has meet or exceeded this ratio then a window update will be sent. This window update ratio will only be applied to `streamId`. Note it is the responsibly of the caller to ensure that the initial `SETTINGS` frame is sent before this is called. It would be considered a `Http2Error#PROTOCOL_ERROR` if a `WINDOW_UPDATE` was generated by this method before the initial `SETTINGS` frame is sent. Parameters stream:Http2Stream the stream for which `ratio` applies to. ratio:float the ratio to use when checking if a `WINDOW_UPDATE` is determined necessary. Exceptions Http2Exception: If a protocol-error occurs while generating `WINDOW_UPDATE` frames

public void windowUpdateRatio(Http2Stream stream, float ratio) throws Http2Exception

The window update ratio is used to determine when a window update must be sent. If the ratio of bytes processed since the last update has meet or exceeded this ratio then a window update will be sent. This window update ratio will only be applied to streamId.

Note it is the responsibly of the caller to ensure that the initial SETTINGS frame is sent before this is called. It would be considered a Http2Error#PROTOCOL_ERROR if a WINDOW_UPDATE was generated by this method before the initial SETTINGS frame is sent.

Parameters

stream:Http2Stream: the stream for which ratio applies to.
ratio:float: the ratio to use when checking if a WINDOW_UPDATE is determined necessary.

Exceptions

Http2Exception:: If a protocol-error occurs while generating WINDOW_UPDATE frames

windowUpdateRatio back to summary

windowUpdateRatio	back to summary
public float windowUpdateRatio(Http2Stream stream) throws Http2Exception The window update ratio is used to determine when a window update must be sent. If the ratio of bytes processed since the last update has meet or exceeded this ratio then a window update will be sent. This window update ratio will only be applied to `streamId`. Exceptions Http2Exception: If no stream corresponding to `stream` could be found.

public float windowUpdateRatio(Http2Stream stream) throws Http2Exception

The window update ratio is used to determine when a window update must be sent. If the ratio of bytes processed since the last update has meet or exceeded this ratio then a window update will be sent. This window update ratio will only be applied to streamId.

Exceptions

Http2Exception:: If no stream corresponding to stream could be found.

io.netty.handler.codec.http2 back to summary

private final Class DefaultHttp2LocalFlowController.AutoRefillState

Class Inheritance

extends DefaultState

java.lang.Object
io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.DefaultState
io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.AutoRefillState

Flow control state that does autorefill of the flow control window when the data is received.

Constructor Summary

Access	Constructor and Description
pack-priv	AutoRefillState(Http2Stream stream, int initialWindowSize)

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public boolean	consumeBytes(int the number of bytes to be returned to the flow control window. numBytes) Overrides io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.DefaultState.consumeBytes. Implements io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.consumeBytes. Indicates that the application has consumed `numBytes` from the connection or stream and is ready to receive more data.
public void	receiveFlowControlledFrame(int The amount of data to for which this stream is no longer eligible to use for flow control. dataLength) Overrides io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.DefaultState.receiveFlowControlledFrame. Implements io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.receiveFlowControlledFrame. A flow control event has occurred and we should decrement the amount of available bytes for this stream.

public boolean

consumeBytes(int

the number of bytes to be returned to the flow control window.

numBytes)

Overrides io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.DefaultState.consumeBytes.

Implements io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.consumeBytes.

Indicates that the application has consumed numBytes from the connection or stream and is ready to receive more data.

public void

receiveFlowControlledFrame(int

The amount of data to for which this stream is no longer eligible to use for flow control.

dataLength)

Overrides io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.DefaultState.receiveFlowControlledFrame.

Implements io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.receiveFlowControlledFrame.

A flow control event has occurred and we should decrement the amount of available bytes for this stream.

Inherited from io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.DefaultState:: endOfStream incrementFlowControlWindows incrementInitialStreamWindow initialWindowSize unconsumedBytes window windowSize windowUpdateRatio windowUpdateRatio writeWindowUpdateIfNeeded

Constructor Detail

AutoRefillState	back to summary
pack-priv AutoRefillState(Http2Stream stream, int initialWindowSize)

Method Detail

consumeBytes back to summary

consumeBytes	back to summary
public boolean consumeBytes(int numBytes) throws Http2Exception Overrides io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.DefaultState.consumeBytes. Implements io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.consumeBytes. Doc from io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.consumeBytes. Indicates that the application has consumed `numBytes` from the connection or stream and is ready to receive more data. Parameters numBytes:int the number of bytes to be returned to the flow control window. Returns:boolean true if `WINDOW_UPDATE` was written, false otherwise. Annotations @Override

public boolean consumeBytes(int numBytes) throws Http2Exception

Overrides io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.DefaultState.consumeBytes.

Implements io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.consumeBytes.

Doc from io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.consumeBytes.

Indicates that the application has consumed numBytes from the connection or stream and is ready to receive more data.

Parameters

numBytes:int: the number of bytes to be returned to the flow control window.

Returns:boolean

true if WINDOW_UPDATE was written, false otherwise.

Annotations

@Override

receiveFlowControlledFrame	back to summary
public void receiveFlowControlledFrame(int dataLength) throws Http2Exception Overrides io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.DefaultState.receiveFlowControlledFrame. Implements io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.receiveFlowControlledFrame. Doc from io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.receiveFlowControlledFrame. A flow control event has occurred and we should decrement the amount of available bytes for this stream. Parameters dataLength:int The amount of data to for which this stream is no longer eligible to use for flow control. Annotations @Override Exceptions Http2Exception: If too much data is used relative to how much is available.

receiveFlowControlledFrame

back to summary

public void receiveFlowControlledFrame(int dataLength) throws Http2Exception

Overrides io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.DefaultState.receiveFlowControlledFrame.

Implements io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.receiveFlowControlledFrame.

Doc from io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.receiveFlowControlledFrame.

A flow control event has occurred and we should decrement the amount of available bytes for this stream.

Parameters

dataLength:int: The amount of data to for which this stream is no longer eligible to use for flow control.

Annotations

@Override

Exceptions

Http2Exception:: If too much data is used relative to how much is available.

io.netty.handler.codec.http2 back to summary

private Class DefaultHttp2LocalFlowController.DefaultState

Class Inheritance

extends Object
implements FlowState

java.lang.Object
io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.DefaultState

All Implemented Interfaces

io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState

Known Direct Subclasses

io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.AutoRefillState

Flow control window state for an individual stream.

Field Summary

Modifier and Type	Field and Description
private boolean	endOfStream
private int	initialStreamWindowSize This is what is used to determine how many bytes need to be returned relative to `processedWindow`.
private int	lowerBound
private int	processedWindow A view of `window` that is used to determine when to send `WINDOW_UPDATE` frames.
private final Http2Stream	stream
private float	streamWindowUpdateRatio This is used to determine when `processedWindow` is sufficiently far away from `initialStreamWindowSize` such that a `WINDOW_UPDATE` should be sent.
private int	window The actual flow control window that is decremented as soon as `DATA` arrives.

Constructor Summary

Access	Constructor and Description
pack-priv	DefaultState(Http2Stream stream, int initialWindowSize)

Method Summary

Modifier and Type	Method and Description
public boolean	consumeBytes(int the number of bytes to be returned to the flow control window. numBytes) Implements io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.consumeBytes. Indicates that the application has consumed `numBytes` from the connection or stream and is ready to receive more data.
public void	endOfStream(boolean endOfStream) Implements io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.endOfStream.
public void	incrementFlowControlWindows(int The amount to increment the window by. delta) Implements io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.incrementFlowControlWindows. Increment the windows which are used to determine many bytes have been processed.
public void	incrementInitialStreamWindow(int The amount to increase the initial window size by. delta) Implements io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.incrementInitialStreamWindow. Increment the initial window size for this stream.
public int	initialWindowSize() Implements io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.initialWindowSize.
public void	receiveFlowControlledFrame(int The amount of data to for which this stream is no longer eligible to use for flow control. dataLength) Implements io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.receiveFlowControlledFrame. A flow control event has occurred and we should decrement the amount of available bytes for this stream.
private void	returnProcessedBytes(int delta)
public int	unconsumedBytes() Implements io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.unconsumedBytes.
public void	window(int initialWindowSize) Implements io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.window.
public int	windowSize() Implements io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.windowSize.
public float	windowUpdateRatio() Implements io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.windowUpdateRatio.
public void	windowUpdateRatio(float ratio) Implements io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.windowUpdateRatio.
private void	writeWindowUpdate() Called to perform a window update for this stream (or connection).
public boolean	writeWindowUpdateIfNeeded() Implements io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.writeWindowUpdateIfNeeded. Updates the flow control window for this stream if it is appropriate.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

endOfStream	back to summary
private boolean endOfStream

initialStreamWindowSize	back to summary
private int initialStreamWindowSize This is what is used to determine how many bytes need to be returned relative to `processedWindow`. Each stream has their own initial window size.

lowerBound	back to summary
private int lowerBound

processedWindow	back to summary
private int processedWindow A view of `window` that is used to determine when to send `WINDOW_UPDATE` frames. Decrementing this window for received `DATA` frames is delayed until the application has indicated that the data has been fully processed. This prevents sending a `WINDOW_UPDATE` until the number of processed bytes drops below the threshold.

stream	back to summary
private final Http2Stream stream

streamWindowUpdateRatio	back to summary
private float streamWindowUpdateRatio This is used to determine when `processedWindow` is sufficiently far away from `initialStreamWindowSize` such that a `WINDOW_UPDATE` should be sent. Each stream has their own window update ratio.

window	back to summary
private int window The actual flow control window that is decremented as soon as `DATA` arrives.

Constructor Detail

DefaultState	back to summary
pack-priv DefaultState(Http2Stream stream, int initialWindowSize)

Method Detail

consumeBytes back to summary

consumeBytes	back to summary
public boolean consumeBytes(int numBytes) throws Http2Exception Implements io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.consumeBytes. Doc from io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.consumeBytes. Indicates that the application has consumed `numBytes` from the connection or stream and is ready to receive more data. Parameters numBytes:int the number of bytes to be returned to the flow control window. Returns:boolean true if `WINDOW_UPDATE` was written, false otherwise. Annotations @Override

public boolean consumeBytes(int numBytes) throws Http2Exception

Implements io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.consumeBytes.

Doc from io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.consumeBytes.

Indicates that the application has consumed numBytes from the connection or stream and is ready to receive more data.

Parameters

numBytes:int: the number of bytes to be returned to the flow control window.

Returns:boolean

true if WINDOW_UPDATE was written, false otherwise.

Annotations

@Override

endOfStream

back to summary

public void endOfStream(boolean endOfStream)

Implements io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.endOfStream.

Annotations

@Override

incrementFlowControlWindows

back to summary

public void incrementFlowControlWindows(int delta) throws Http2Exception

Implements io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.incrementFlowControlWindows.

Doc from io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.incrementFlowControlWindows.

Increment the windows which are used to determine many bytes have been processed.

Parameters

delta:int: The amount to increment the window by.

Annotations

@Override

Exceptions

Http2Exception:: if integer overflow occurs on the window.

incrementInitialStreamWindow

back to summary

public void incrementInitialStreamWindow(int delta)

Implements io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.incrementInitialStreamWindow.

Doc from io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.incrementInitialStreamWindow.

Increment the initial window size for this stream.

Parameters

delta:int: The amount to increase the initial window size by.

Annotations

@Override

initialWindowSize

back to summary

public int initialWindowSize()

Implements io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.initialWindowSize.

Annotations

@Override

receiveFlowControlledFrame

back to summary

public void receiveFlowControlledFrame(int dataLength) throws Http2Exception

Implements io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.receiveFlowControlledFrame.

Doc from io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.receiveFlowControlledFrame.

A flow control event has occurred and we should decrement the amount of available bytes for this stream.

Parameters

dataLength:int: The amount of data to for which this stream is no longer eligible to use for flow control.

Annotations

@Override

Exceptions

Http2Exception:: If too much data is used relative to how much is available.

returnProcessedBytes	back to summary
private void returnProcessedBytes(int delta) throws Http2Exception

unconsumedBytes

back to summary

public int unconsumedBytes()

Implements io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.unconsumedBytes.

Annotations

@Override

window

back to summary

public void window(int initialWindowSize)

Implements io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.window.

Annotations

@Override

windowSize

back to summary

public int windowSize()

Implements io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.windowSize.

Annotations

@Override

windowUpdateRatio

back to summary

public float windowUpdateRatio()

Implements io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.windowUpdateRatio.

Annotations

@Override

windowUpdateRatio

back to summary

public void windowUpdateRatio(float ratio)

Implements io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.windowUpdateRatio.

Annotations

@Override

writeWindowUpdate	back to summary
private void writeWindowUpdate() throws Http2Exception Called to perform a window update for this stream (or connection). Updates the window size back to the size of the initial window and sends a window update frame to the remote endpoint.

writeWindowUpdateIfNeeded back to summary

public boolean writeWindowUpdateIfNeeded() throws Http2Exception

Implements io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.writeWindowUpdateIfNeeded.

Doc from io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.FlowState.writeWindowUpdateIfNeeded.

Updates the flow control window for this stream if it is appropriate.

Returns:boolean

true if WINDOW_UPDATE was written, false otherwise.

Annotations

@Override

io.netty.handler.codec.http2 back to summary

private Interface DefaultHttp2LocalFlowController.FlowState

Known Direct Implementers: io.netty.handler.codec.http2.DefaultHttp2LocalFlowController.DefaultState

An abstraction which provides specific extensions used by local flow control.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: true if `WINDOW_UPDATE` was written, false otherwise. consumeBytes(int the number of bytes to be returned to the flow control window. numBytes) Indicates that the application has consumed `numBytes` from the connection or stream and is ready to receive more data.
public void	endOfStream(boolean endOfStream)
public void	incrementFlowControlWindows(int The amount to increment the window by. delta) Increment the windows which are used to determine many bytes have been processed.
public void	incrementInitialStreamWindow(int The amount to increase the initial window size by. delta) Increment the initial window size for this stream.
public int	initialWindowSize()
public void	receiveFlowControlledFrame(int The amount of data to for which this stream is no longer eligible to use for flow control. dataLength) A flow control event has occurred and we should decrement the amount of available bytes for this stream.
public int	unconsumedBytes()
public void	window(int initialWindowSize)
public int	windowSize()
public float	windowUpdateRatio()
public void	windowUpdateRatio(float ratio)
public boolean	Returns: true if `WINDOW_UPDATE` was written, false otherwise. writeWindowUpdateIfNeeded() Updates the flow control window for this stream if it is appropriate.

Method Detail

consumeBytes back to summary

public boolean consumeBytes(int numBytes) throws Http2Exception

Indicates that the application has consumed numBytes from the connection or stream and is ready to receive more data.

Parameters

numBytes:int: the number of bytes to be returned to the flow control window.

Returns:boolean

true if WINDOW_UPDATE was written, false otherwise.

endOfStream	back to summary
public void endOfStream(boolean endOfStream)

incrementFlowControlWindows

back to summary

public void incrementFlowControlWindows(int delta) throws Http2Exception

Increment the windows which are used to determine many bytes have been processed.

Parameters

delta:int: The amount to increment the window by.

Exceptions

Http2Exception:: if integer overflow occurs on the window.

incrementInitialStreamWindow

back to summary

public void incrementInitialStreamWindow(int delta)

Increment the initial window size for this stream.

Parameters

delta:int: The amount to increase the initial window size by.

initialWindowSize	back to summary
public int initialWindowSize()

receiveFlowControlledFrame

back to summary

public void receiveFlowControlledFrame(int dataLength) throws Http2Exception

A flow control event has occurred and we should decrement the amount of available bytes for this stream.

Parameters

dataLength:int: The amount of data to for which this stream is no longer eligible to use for flow control.

Exceptions

Http2Exception:: If too much data is used relative to how much is available.

unconsumedBytes	back to summary
public int unconsumedBytes()

window	back to summary
public void window(int initialWindowSize)

windowSize	back to summary
public int windowSize()

windowUpdateRatio	back to summary
public float windowUpdateRatio()

windowUpdateRatio	back to summary
public void windowUpdateRatio(float ratio)

writeWindowUpdateIfNeeded back to summary

public boolean writeWindowUpdateIfNeeded() throws Http2Exception

Updates the flow control window for this stream if it is appropriate.

Returns:boolean: true if WINDOW_UPDATE was written, false otherwise.

public Class DefaultHttp2LocalFlowController

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class DefaultHttp2LocalFlowController.AutoRefillState

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class DefaultHttp2LocalFlowController.DefaultState

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Interface DefaultHttp2LocalFlowController.FlowState

Method Summary

Method Detail

private final Class DefaultHttp2LocalFlowController.WindowUpdateVisitor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Field and Description
private Http2Exception.CompositeStreamException	compositeException
private final int	delta

Modifier and Type	Method and Description
public void	throwIfError()
public boolean	visit(Http2Stream stream) Implements io.netty.handler.codec.http2.Http2StreamVisitor.visit.