io.netty.handler.codec.http2

Class DefaultHttp2RemoteFlowController

java.lang.Object

io.netty.handler.codec.http2.DefaultHttp2RemoteFlowController

All Implemented Interfaces:

Http2FlowController, Http2RemoteFlowController

public class DefaultHttp2RemoteFlowController
extends Object
implements Http2RemoteFlowController

Basic implementation of Http2RemoteFlowController.

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.handler.codec.http2.Http2RemoteFlowController

Http2RemoteFlowController.FlowControlled

Constructor Summary

Constructors

Constructor and Description
DefaultHttp2RemoteFlowController(Http2Connection connection)

Method Summary

Methods

Modifier and Type	Method and Description
void	incrementWindowSize(ChannelHandlerContext ctx, Http2Stream stream, int delta) Increments the size of the stream's flow control window by the given delta.
int	initialWindowSize() Gets the initial flow control window size that is used as the basis for new stream flow control windows.
void	initialWindowSize(int newWindowSize) Sets the initial flow control window and updates all stream windows (but not the connection window) by the delta.
void	sendFlowControlled(ChannelHandlerContext ctx, Http2Stream stream, Http2RemoteFlowController.FlowControlled payload) Writes or queues a payload for transmission to the remote endpoint.
int	windowSize(Http2Stream stream) Gets the number of bytes remaining in the flow control window size for the given stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultHttp2RemoteFlowController

public DefaultHttp2RemoteFlowController(Http2Connection connection)

Method Detail

initialWindowSize

public void initialWindowSize(int newWindowSize)
                       throws Http2Exception

Description copied from interface: Http2FlowController

Sets the initial flow control window and updates all stream windows (but not the connection window) by the delta.

This method is used to apply the SETTINGS_INITIAL_WINDOW_SIZE value for an SETTINGS frame.

Specified by:

initialWindowSize in interface Http2FlowController

Parameters:

newWindowSize - the new initial window size.

Throws:

Http2Exception - thrown if any protocol-related error occurred.

initialWindowSize

public int initialWindowSize()

Description copied from interface: Http2FlowController

Gets the initial flow control window size that is used as the basis for new stream flow control windows.

Specified by:

initialWindowSize in interface Http2FlowController

windowSize

public int windowSize(Http2Stream stream)

Description copied from interface: Http2FlowController

Gets the number of bytes remaining in the flow control window size for the given stream.

Specified by:

windowSize in interface Http2FlowController

Parameters:

stream - The subject stream. Use Http2Connection.connectionStream() for requesting the size of the connection window.

Returns:

the current size of the flow control window.

incrementWindowSize

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

Description copied from interface: Http2FlowController

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.

Specified by:

incrementWindowSize in interface Http2FlowController

Parameters:

ctx - The context for the calling handler

stream - The subject stream. Use Http2Connection.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.

sendFlowControlled

public void sendFlowControlled(ChannelHandlerContext ctx,
                      Http2Stream stream,
                      Http2RemoteFlowController.FlowControlled payload)

Description copied from interface: Http2RemoteFlowController

Writes or queues a payload for transmission to the remote endpoint. There is no guarantee when the data will be written or whether it will be split into multiple frames before sending.

Manually flushing the ChannelHandlerContext is not required, since the flow controller will flush as appropriate.

Specified by:

sendFlowControlled in interface Http2RemoteFlowController

Parameters:

ctx - the context from the handler.

stream - the subject stream. Must not be the connection stream object.

payload - payload to write subject to flow-control accounting and ordering rules.