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.
| Modifier and Type | Field and Description |
|---|---|
| private float | |
| private static final Logger | |
| private final AtomicInteger | |
| private final AtomicInteger | |
| private final Map |
| Access | Constructor and Description |
|---|---|
| public | |
| public |
| Modifier and Type | Method and Description |
|---|---|
| public float | |
| public void | onDataConsumed(Session session, Stream stream, int length)
Implements org.
|
| public void | |
| public void | |
| public void | |
| public String | |
| public void | windowUpdate(Session session, Stream stream, WindowUpdateFrame frame)
Overrides org. Implements org.
|
| bufferRatio | back to summary |
|---|---|
| private float bufferRatio | |
| LOG | back to summary |
|---|---|
| private static final Logger LOG Hides org. | |
| maxSessionRecvWindow | back to summary |
|---|---|
| private final AtomicInteger maxSessionRecvWindow | |
| sessionLevel | back to summary |
|---|---|
| private final AtomicInteger sessionLevel | |
| streamLevels | back to summary |
|---|---|
| private final Map<Stream, AtomicInteger> streamLevels | |
| BufferingFlowControlStrategy | back to summary |
|---|---|
| public BufferingFlowControlStrategy(float bufferRatio) | |
| BufferingFlowControlStrategy | back to summary |
|---|---|
| public BufferingFlowControlStrategy(int initialStreamSendWindow, float bufferRatio) | |
| getBufferRatio | back to summary |
|---|---|
public float getBufferRatio()
| |
| onDataConsumed | back to summary |
|---|---|
| public void onDataConsumed(Session session, Stream stream, int length) Implements org.
| |
| onStreamCreated | back to summary |
|---|---|
| public void onStreamCreated(Stream stream) Overrides org. Implements org.
| |
| onStreamDestroyed | back to summary |
|---|---|
| public void onStreamDestroyed(Stream stream) Overrides org. Implements org.
| |
| setBufferRatio | back to summary |
|---|---|
| public void setBufferRatio(float bufferRatio) | |
| toString | back to summary |
|---|---|
| public String toString() Overrides java. Doc from java. Returns a string representation of the object.
Satisfying this method's contract implies a non- | |
| windowUpdate | back to summary |
|---|---|
| public void windowUpdate(Session session, Stream stream, WindowUpdateFrame frame) Overrides org. Implements org.
| |