io.netty.handler.codec.http2

Interface Http2RemoteFlowController

All Superinterfaces:

Http2FlowController

All Known Implementing Classes:

DefaultHttp2RemoteFlowController

public interface Http2RemoteFlowController
extends Http2FlowController

A Http2FlowController for controlling the flow of outbound DATA frames to the remote endpoint.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Http2RemoteFlowController.FlowControlled Implementations of this interface are used to progressively write chunks of the underlying payload to the stream.
static interface	Http2RemoteFlowController.Listener Listener to the number of flow-controlled bytes written per stream.

Method Summary

Methods

Modifier and Type	Method and Description
void	addFlowControlled(Http2Stream stream, Http2RemoteFlowController.FlowControlled payload) Queues a payload for transmission to the remote endpoint.
ChannelHandlerContext	channelHandlerContext() Get the ChannelHandlerContext for which to apply flow control on.
Http2RemoteFlowController.Listener	listener() Get the current listener to flow-control events.
void	listener(Http2RemoteFlowController.Listener listener) Set the active listener on the flow-controller.
void	writePendingBytes() Write all data pending in the flow controller up to the flow-control limits.

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

channelHandlerContext, incrementWindowSize, initialWindowSize, initialWindowSize, initialWindowSize, windowSize

Method Detail

channelHandlerContext

ChannelHandlerContext channelHandlerContext()

Get the ChannelHandlerContext for which to apply flow control on.

This is intended for us by Http2RemoteFlowController.FlowControlled implementations only. Use with caution.

Returns:

The ChannelHandlerContext for which to apply flow control on.

addFlowControlled

void addFlowControlled(Http2Stream stream,
                     Http2RemoteFlowController.FlowControlled payload)

Queues a payload for transmission to the remote endpoint. There is no guarantee as to when the data will be written or how it will be allocated to frames. before sending.

Writes do not actually occur until writePendingBytes() is called.

Parameters:

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

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

writePendingBytes

void writePendingBytes()
                       throws Http2Exception

Write all data pending in the flow controller up to the flow-control limits.

Throws:

Http2Exception - throws if a protocol-related error occurred.

listener

void listener(Http2RemoteFlowController.Listener listener)

Set the active listener on the flow-controller.

Parameters:

listener - to notify when the a write occurs, can be null.

listener

Http2RemoteFlowController.Listener listener()

Get the current listener to flow-control events.

Returns:

the current listener or null if one is not set.