RingBufferPlus API:IRingBufferScaleMax
IRingBufferScaleMax<T>
Namespace: RingBufferPlus
Represents the MaxCapacity commands to RingBufferPlus.
public interface IRingBufferScaleMax<T>
Type Parameters
T
Type of buffer.
Methods
Build()
Validate and generate RingBufferPlus to service mode.
IRingBufferService<T> Build()
Returns
BuildWarmup(ref Boolean, Nullable<TimeSpan>)
Validate and generate RingBufferPlus and warmup with full capacity ready or reaching timeout (default 30 seconds).
IRingBufferService<T> BuildWarmup(ref Boolean fullcapacity, Nullable<TimeSpan> timeout)
Parameters
fullcapacity Boolean&
True if Warmup has full capacity, otherwise false.
timeout Nullable<TimeSpan>
The Timeout to Warmup has full capacity. Default value is 30 seconds.
Returns
MinCapacity(Int32)
Minimum capacity.
IRingBufferScaleMin<T> MinCapacity(int value)
Parameters
value Int32
The minimum buffer.
Returns
RollbackWhenFreeGreaterEq(Nullable<Int32>)
Condition to scale down to default capacity.
The free resource collected must be greater than or equal to value.
RollbackWhenFreeGreaterEq do not used with TriggerByAccqWhenFreeGreaterEq command.
RollbackWhenFreeGreaterEq do not use with Manual/Slave scale
IRingBufferScaleMax<T> RollbackWhenFreeGreaterEq(Nullable<Int32> value)
Parameters
value Nullable<Int32>
Number to trigger.
The free resource collected must be greater than or equal to value.
Default = Min (Min = MaxCapacity-Capacity, Max = MaxCapacity).
Returns
ScaleWhenFreeLessEq(Nullable<Int32>)
Condition to scale up to max capacity.
The free resource collected must be less than or equal to value.
ScaleWhenFreeLessEq do not use with Manual/Slave scale
IRingBufferScaleMax<T> ScaleWhenFreeLessEq(Nullable<Int32> value)
Parameters
value Nullable<Int32>
Number to trigger.
The free resource collected must be less than or equal to value.
Default = Min (Min = 2, Max = Capacity).
Returns
TriggerByAccqWhenFreeGreaterEq(Nullable<Int32>)
Condition to scale down to default capacity foreach accquire.
The free resource collected at aqccquire must be greater than or equal to value.
TriggerByAccqWhenFreeGreaterEq do not used with RollbackWhenFreeGreaterEq command.
TriggerByAccqWhenFreeGreaterEq do not use with Manual/Slave scale
IRingBufferScaleMax<T> TriggerByAccqWhenFreeGreaterEq(Nullable<Int32> value)
Parameters
value Nullable<Int32>
Number to trigger.
The free resource collected must be greater than or equal to value.
Default = Min (Min = MaxCapacity-Capacity, Max = MaxCapacity)