Package io.netty.handler.codec.http2
Interface Http2RemoteFlowController.FlowControlled
- All Known Implementing Classes:
DefaultHttp2ConnectionEncoder.FlowControlledBase
,DefaultHttp2ConnectionEncoder.FlowControlledData
,DefaultHttp2ConnectionEncoder.FlowControlledHeaders
- Enclosing interface:
Http2RemoteFlowController
public static interface Http2RemoteFlowController.FlowControlled
Implementations of this interface are used to progressively write chunks of the underlying
payload to the stream. A payload is considered to be fully written if
write(io.netty.channel.ChannelHandlerContext, int)
has
been called at least once and it's size()
is now zero.-
Method Summary
Modifier and TypeMethodDescriptionvoid
error
(ChannelHandlerContext ctx, Throwable cause) Called to indicate that an error occurred before this object could be completely written.boolean
Merge the contents of thenext
message into this message so they can be written out as one unit.int
size()
The size of the payload in terms of bytes applied to the flow-control window.void
write
(ChannelHandlerContext ctx, int allowedBytes) Writes up toallowedBytes
of the encapsulated payload to the stream.void
Called after this object has been successfully written.
-
Method Details
-
size
int size()The size of the payload in terms of bytes applied to the flow-control window. Some payloads likeHEADER
frames have no cost against flow control and would return 0 for this value even though they produce a non-zero number of bytes on the wire. Other frames likeDATA
frames have both their payload and padding count against flow-control. -
error
Called to indicate that an error occurred before this object could be completely written.The
Http2RemoteFlowController
will make exactly one call to either this method orwriteComplete()
.- Parameters:
ctx
- The context to use if any communication needs to occur as a result of the error. This may benull
if an exception occurs when the connection has not been established yet.cause
- of the error.
-
writeComplete
void writeComplete()Called after this object has been successfully written.The
Http2RemoteFlowController
will make exactly one call to either this method orerror(ChannelHandlerContext, Throwable)
. -
write
Writes up toallowedBytes
of the encapsulated payload to the stream. Note that a value of 0 may be passed which will allow payloads with flow-control size == 0 to be written. The flow-controller may call this method multiple times with different values until the payload is fully written, i.e it's size after the write is 0.When an exception is thrown the
Http2RemoteFlowController
will make a call toerror(ChannelHandlerContext, Throwable)
.- Parameters:
ctx
- The context to use for writing.allowedBytes
- an upper bound on the number of bytes the payload can write at this time.
-
merge
Merge the contents of thenext
message into this message so they can be written out as one unit. This allows many small messages to be written as a single DATA frame.- Returns:
true
ifnext
was successfully merged and does not need to be enqueued,false
otherwise.
-