Package org.eclipse.jetty.http2

Class BufferingFlowControlStrategy

java.lang.Object

org.eclipse.jetty.http2.AbstractFlowControlStrategy

org.eclipse.jetty.http2.BufferingFlowControlStrategy

All Implemented Interfaces:

FlowControlStrategy, Dumpable

@ManagedObject
public class BufferingFlowControlStrategy
extends AbstractFlowControlStrategy

A flow control strategy that accumulates updates and emits window control frames when the accumulated value reaches a threshold.

The sender flow control window is represented in the receiver as two buckets: a bigger bucket, initially full, that is drained when data is received, and a smaller bucket, initially empty, that is filled when data is consumed. Only the smaller bucket can refill the bigger bucket.

The smaller bucket is defined as a fraction of the bigger bucket.

For a more visual representation, see the rocking bamboo fountain, where the bamboo is the smaller bucket and the pool is the bigger bucket.

The algorithm works in this way.

The initial bigger bucket (BB) capacity is 100, and let's imagine the smaller bucket (SB) being 40% of the bigger bucket: 40.

The receiver receives a data frame of 60, so now BB=40; the data frame is passed to the application that consumes 25, so now SB=25. Since SB is not full, no window control frames are emitted.

The application consumes other 20, so now SB=45. Since SB is full, its 45 are transferred to BB, which is now BB=85, and a window control frame is sent with delta=45.

The application consumes the remaining 15, so now SB=15, and no window control frame is emitted.

The bufferRatio controls how often the window control frame is emitted.

A bufferRatio=0.0 means that a window control frame is emitted every time the application consumes a data frame. This may result in too many window control frames be emitted, but may allow the sender to avoid stalling.

A bufferRatio=1.0 means that a window control frame is emitted only when the application has consumed a whole window. This minimizes the number of window control frames emitted, but may cause the sender to stall, waiting for the window control frame.

The default value is bufferRatio=0.5.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

Dumpable.DumpableContainer

Nested classes/interfaces inherited from interface org.eclipse.jetty.http2.FlowControlStrategy

FlowControlStrategy.Factory

Field Summary

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

KEY

Fields inherited from interface org.eclipse.jetty.http2.FlowControlStrategy

DEFAULT_WINDOW_SIZE

Constructor Summary

Constructors

Constructor	Description
BufferingFlowControlStrategy(float bufferRatio)
BufferingFlowControlStrategy(int initialStreamSendWindow, float bufferRatio)

Method Summary

Modifier and Type	Method	Description
float	getBufferRatio()
void	onDataConsumed(Session session, Stream stream, int length)
void	onStreamCreated(Stream stream)
void	onStreamDestroyed(Stream stream)
void	setBufferRatio(float bufferRatio)
String	toString()
void	windowUpdate(Session session, Stream stream, WindowUpdateFrame frame)

Methods inherited from class org.eclipse.jetty.http2.AbstractFlowControlStrategy

dump, dump, getInitialStreamRecvWindow, getInitialStreamSendWindow, getSessionStallTime, getStreamsStallTime, onDataReceived, onDataSending, onDataSent, onSessionStalled, onSessionUnstalled, onStreamStalled, onStreamUnstalled, onWindowUpdate, reset, sendWindowUpdate, updateInitialStreamWindow, updateRecvWindow, updateRecvWindow, updateSendWindow, updateSendWindow, updateWindow

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

dumpSelf

Constructor Details

BufferingFlowControlStrategy

public BufferingFlowControlStrategy(float bufferRatio)

BufferingFlowControlStrategy

public BufferingFlowControlStrategy(int initialStreamSendWindow,
 float bufferRatio)

Method Details

getBufferRatio

@ManagedAttribute("The ratio between the receive buffer and the consume buffer")
public float getBufferRatio()

setBufferRatio

public void setBufferRatio(float bufferRatio)

onStreamCreated

public void onStreamCreated(Stream stream)

Specified by:

onStreamCreated in interface FlowControlStrategy

Overrides:

onStreamCreated in class AbstractFlowControlStrategy

onStreamDestroyed

public void onStreamDestroyed(Stream stream)

Specified by:

onStreamDestroyed in interface FlowControlStrategy

Overrides:

onStreamDestroyed in class AbstractFlowControlStrategy

onDataConsumed

public void onDataConsumed(Session session,
 Stream stream,
 int length)

windowUpdate

public void windowUpdate(Session session,
 Stream stream,
 WindowUpdateFrame frame)

Specified by:

windowUpdate in interface FlowControlStrategy

Overrides:

windowUpdate in class AbstractFlowControlStrategy

toString

public String toString()

Overrides:

toString in class Object