io.netty.handler.codec.http2

Interface Http2LocalFlowController

All Superinterfaces:

Http2FlowController

All Known Implementing Classes:

DefaultHttp2LocalFlowController

public interface Http2LocalFlowController
extends Http2FlowController

A Http2FlowController for controlling the inbound flow of DATA frames from the remote endpoint.

Method Summary

Methods

Modifier and Type	Method and Description
void	consumeBytes(ChannelHandlerContext ctx, Http2Stream stream, int numBytes) 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.
void	receiveFlowControlledFrame(ChannelHandlerContext ctx, Http2Stream stream, ByteBuf data, int padding, boolean endOfStream) 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.
int	unconsumedBytes(Http2Stream stream) The number of bytes for the given stream that have been received but not yet consumed by the application.

Methods inherited from interface io.netty.handler.codec.http2.Http2FlowController

incrementWindowSize, initialWindowSize, initialWindowSize, windowSize

Method Detail

receiveFlowControlledFrame

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

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.

Parameters:

ctx - the context from the handler where the frame was read.

stream - the subject stream for the received frame. The connection stream object must not be used.

data - payload buffer for the frame.

padding - the number of padding bytes found at the end of the frame.

endOfStream - Indicates whether this is the last frame to be sent from the remote endpoint for this stream.

Throws:

Http2Exception - if any flow control errors are encountered.

consumeBytes

void consumeBytes(ChannelHandlerContext ctx,
                Http2Stream stream,
                int numBytes)
                  throws Http2Exception

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.

Parameters:

ctx - the channel handler context to use when sending a WINDOW_UPDATE if appropriate

stream - the stream for which window space should be freed. The connection stream object must not be used.

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

Throws:

Http2Exception - if the number of bytes returned exceeds the unconsumedBytes(io.netty.handler.codec.http2.Http2Stream) for the stream.

unconsumedBytes

int unconsumedBytes(Http2Stream stream)

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

Parameters:

stream - the stream for which window space should be freed.

Returns:

the number of unconsumed bytes for the stream.