Class FlowControlSettings (2.18.1) 

public abstract class FlowControlSettings

Settings for FlowController.

Inheritance

java.lang.Object > FlowControlSettings

Static Methods

getDefaultInstance()

public static FlowControlSettings getDefaultInstance()
Returns
TypeDescription
FlowControlSettings

newBuilder()

public static FlowControlSettings.Builder newBuilder()
Returns
TypeDescription
FlowControlSettings.Builder

Constructors

FlowControlSettings()

public FlowControlSettings()

Methods

getLimitExceededBehavior()

public abstract FlowController.LimitExceededBehavior getLimitExceededBehavior()

The behavior of FlowController when the specified limits are exceeded. Defaults to Block.

The expected behavior for each of these values is:

  • ThrowException: the FlowController will throw a FlowControlException if any of the limits are exceeded.
  • Block: the reserve() method of FlowController will block until the quote is available to be reserved.
  • Ignore: all flow control limits will be ignored; the FlowController is disabled.
Returns
TypeDescription
FlowController.LimitExceededBehavior

getMaxOutstandingElementCount()

public abstract Long getMaxOutstandingElementCount()

Maximum number of outstanding elements to keep in memory before enforcing flow control.

Returns
TypeDescription
Long

getMaxOutstandingRequestBytes()

public abstract Long getMaxOutstandingRequestBytes()

Maximum number of outstanding bytes to keep in memory before enforcing flow control.

Returns
TypeDescription
Long

toBuilder()

public abstract FlowControlSettings.Builder toBuilder()
Returns
TypeDescription
FlowControlSettings.Builder