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.

Method Summary

Methods

Modifier and Type	Method and Description
void	sendFlowControlled(ChannelHandlerContext ctx, Http2Stream stream, Http2RemoteFlowController.FlowControlled payload) Writes or queues a payload for transmission to the remote endpoint.

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

incrementWindowSize, initialWindowSize, initialWindowSize, windowSize

Method Detail

sendFlowControlled

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

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.

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.