io.engineblock.activityimpl.input

Class TargetRateInput

java.lang.Object

io.engineblock.activityimpl.input.TargetRateInput

All Implemented Interfaces:

ActivityDefObserver, Input, RateLimiterProvider, ProgressCapable

public class TargetRateInput
extends Object
implements Input, ActivityDefObserver, RateLimiterProvider, ProgressCapable

TODO: This documentation is out of date as of 2.0.0

This input will provide threadsafe access to a sequence of long values.

If the targetrate parameter is set on the activity def, then the rate of grants will also be throttled to that rate.

Changes to the cycles or the targetrate will affect the provided inputs. If the min or max cycle is changed, then these are re-applied first to the max cycle and then to the min cycle. If the min cycle is changed, then the next cycle value is set to the assigned min value. Otherwise, the cycle will continue as usual till it reaches the max value. The ability to reset the input while running by applying a new set of parameters makes it possible to re-trigger a sequence of inputs during a test.

This input, and Inputs in general do not actively prevent usage of values after the max value. They simply expose it to callers. It is up to the caller to check the value to determine when the input is deemed "used up."

Constructor Summary

Constructors

Constructor and Description
TargetRateInput(ActivityDef activityDef)

Method Summary

Modifier and Type	Method and Description
CycleSegment	getInputSegment(int stride) Return the next InputSegment available, or null if none were available.
double	getProgress()
com.google.common.util.concurrent.RateLimiter	getRateLimiter()
double	getTotal()
boolean	isContiguous()
void	onActivityDefUpdate(ActivityDef activityDef)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TargetRateInput

public TargetRateInput(ActivityDef activityDef)

Method Detail

getInputSegment

public CycleSegment getInputSegment(int stride)

Description copied from interface: Input

Return the next InputSegment available, or null if none were available. This method is required to be thread safe.

All implementations of this method are required to be thread-safe.

Specified by:

getInputSegment in interface Input

Parameters:

stride - The number of cycles (not necessarily contiguous) in the segment.

Returns:

a segment, or null if none available.

getProgress

public double getProgress()

Specified by:

getProgress in interface ProgressCapable

getTotal

public double getTotal()

Specified by:

getTotal in interface ProgressCapable

toString

public String toString()

Overrides:

toString in class Object

onActivityDefUpdate

public void onActivityDefUpdate(ActivityDef activityDef)

Specified by:

onActivityDefUpdate in interface ActivityDefObserver

getRateLimiter

public com.google.common.util.concurrent.RateLimiter getRateLimiter()

Specified by:

getRateLimiter in interface RateLimiterProvider

isContiguous

public boolean isContiguous()

Specified by:

isContiguous in interface Input