Package io.netty.handler.codec.http2
Class DefaultHttp2ConnectionEncoder.FlowControlledData
- java.lang.Object
-
- io.netty.handler.codec.http2.DefaultHttp2ConnectionEncoder.FlowControlledBase
-
- io.netty.handler.codec.http2.DefaultHttp2ConnectionEncoder.FlowControlledData
-
- All Implemented Interfaces:
ChannelFutureListener
,Http2RemoteFlowController.FlowControlled
,GenericFutureListener<ChannelFuture>
,java.util.EventListener
- Enclosing class:
- DefaultHttp2ConnectionEncoder
private final class DefaultHttp2ConnectionEncoder.FlowControlledData extends DefaultHttp2ConnectionEncoder.FlowControlledBase
Wrap a DATA frame so it can be written subject to flow-control. Note that this implementation assumes it only writes padding once for the entire payload as opposed to writing it once per-frame. This makes thesize()
calculation deterministic thereby greatly simplifying the implementation.If frame-splitting is required to fit within max-frame-size and flow-control constraints we ensure that the passed promise is not completed until last frame write.
-
-
Field Summary
Fields Modifier and Type Field Description private int
dataSize
private CoalescingBufferQueue
queue
-
Fields inherited from class io.netty.handler.codec.http2.DefaultHttp2ConnectionEncoder.FlowControlledBase
endOfStream, padding, promise, stream
-
Fields inherited from interface io.netty.channel.ChannelFutureListener
CLOSE, CLOSE_ON_FAILURE, FIRE_EXCEPTION_ON_FAILURE
-
-
Constructor Summary
Constructors Constructor Description FlowControlledData(Http2Stream stream, ByteBuf buf, int padding, boolean endOfStream, ChannelPromise promise)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
error(ChannelHandlerContext ctx, java.lang.Throwable cause)
Called to indicate that an error occurred before this object could be completely written.boolean
merge(ChannelHandlerContext ctx, Http2RemoteFlowController.FlowControlled next)
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.-
Methods inherited from class io.netty.handler.codec.http2.DefaultHttp2ConnectionEncoder.FlowControlledBase
operationComplete, writeComplete
-
-
-
-
Field Detail
-
queue
private final CoalescingBufferQueue queue
-
dataSize
private int dataSize
-
-
Constructor Detail
-
FlowControlledData
FlowControlledData(Http2Stream stream, ByteBuf buf, int padding, boolean endOfStream, ChannelPromise promise)
-
-
Method Detail
-
size
public int size()
Description copied from interface:Http2RemoteFlowController.FlowControlled
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
public void error(ChannelHandlerContext ctx, java.lang.Throwable cause)
Description copied from interface:Http2RemoteFlowController.FlowControlled
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 orHttp2RemoteFlowController.FlowControlled.writeComplete()
.- 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.
-
write
public void write(ChannelHandlerContext ctx, int allowedBytes)
Description copied from interface:Http2RemoteFlowController.FlowControlled
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 toHttp2RemoteFlowController.FlowControlled.error(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
public boolean merge(ChannelHandlerContext ctx, Http2RemoteFlowController.FlowControlled next)
Description copied from interface:Http2RemoteFlowController.FlowControlled
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.
-
-