io.engineblock.activityimpl.input

Class TargetRateInput

java.lang.Object

io.engineblock.activityimpl.input.TargetRateInput

All Implemented Interfaces:

ActivityDefObserver, Input, longIntervalSupplier, RateLimiterProvider, LongSupplier

public class TargetRateInput
extends Object
implements Input, ActivityDefObserver, RateLimiterProvider

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
long	getAsLong() For the sake of efficiency, ActivityMotors that consume values from this interface should do a range check after getting the value.
long	getCurrent()
long	getInterval(long stride) For the sake of efficiency, ActivityMotors that consume values from this interface should do a range check after getting the value.
AtomicLong	getMax()
AtomicLong	getMin()
com.google.common.util.concurrent.RateLimiter	getRateLimiter()
void	onActivityDefUpdate(ActivityDef activityDef)
TargetRateInput	setNextValue(long newValue)

Methods inherited from class java.lang.Object

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

Constructor Detail

TargetRateInput

public TargetRateInput(ActivityDef activityDef)

Method Detail

setNextValue

public TargetRateInput setNextValue(long newValue)

getAsLong

public long getAsLong()

Description copied from interface: Input

For the sake of efficiency, ActivityMotors that consume values from this interface should do a range check after getting the value. When the value exceeds the the value provided by Input.getMax(), the motor should take this as a signal to terminate gracefully with a log line indicating why.

Specified by:

getAsLong in interface Input

Specified by:

getAsLong in interface LongSupplier

Returns:

The next long value in the sequence

getInterval

public long getInterval(long stride)

Description copied from interface: Input

For the sake of efficiency, ActivityMotors that consume values from this interface should do a range check after getting the value. When the value exceeds the value provided by getMax, the motor should take this as a signal to terminate gracefullly with a log line indicating why.

Specified by:

getInterval in interface Input

Specified by:

getInterval in interface longIntervalSupplier

Parameters:

stride - The width of the interval of numbers returned

Returns:

the first value of the interval

getMin

public AtomicLong getMin()

Specified by:

getMin in interface Input

Returns:

the minimum value to be provided by this input sequence.

getMax

public AtomicLong getMax()

Specified by:

getMax in interface Input

Returns:

the maximum value to be provided by this input sequence.

getCurrent

public long getCurrent()

Specified by:

getCurrent in interface Input

Returns:

the current value of the atomic register used by this input.

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