final class CounterBuilder extends ActionBuilder
Builder of an action that stores an incrementing value into the virtual users' Session. Values
are shared amongst all the virtual users of this load generator, unless #perUser() is
used, in which case dynamic values become available on the returned PerUserCounterBuilder.
Immutable, so all methods return a new occurrence and leave the original unmodified.
- Alphabetic
- By Inheritance
- CounterBuilder
- ActionBuilder
- Executable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def asScala(): core.action.builder.ActionBuilder
For internal use only
For internal use only
- returns
the wrapped Scala instance
- Definition Classes
- CounterBuilder → ActionBuilder
- Annotations
- @Override()
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def perUser(): PerUserCounterBuilder
Track the counter independently for each virtual user, so they all get the very same sequence of values, instead of sharing one single sequence.
Track the counter independently for each virtual user, so they all get the very same sequence of values, instead of sharing one single sequence. Also unlocks dynamic values, eg functions and Gatling EL Strings, for
PerUserCounterBuilder#startingAt,PerUserCounterBuilder#withIncrementandPerUserCounterBuilder#upTo, as a range resolved from one virtual user's Session couldn't define the sequence shared by all of them.- returns
a new PerUserCounterBuilder
- Annotations
- @NonNull()
- def shard(): CounterBuilder
Distribute the values evenly amongst all the load generators of a Gatling Enterprise cluster, so they remain unique cluster wide.
Distribute the values evenly amongst all the load generators of a Gatling Enterprise cluster, so they remain unique cluster wide. Only effective when the test is running with Gatling Enterprise, noop otherwise. Each load generator only gets a slice of the range, so the values emitted by the whole cluster have holes.
- returns
a new CounterBuilder
- Annotations
- @NonNull()
- def startingAt(start: Int): CounterBuilder
Set the first value to be emitted.
Set the first value to be emitted. Must be positive. Default is 0.
- start
the first value
- returns
a new CounterBuilder
- Annotations
- @NonNull()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toChainBuilder(): ChainBuilder
For internal use only
For internal use only
- returns
a ChainBuilder
- Definition Classes
- ActionBuilder → Executable
- Annotations
- @Override()
- def toString(): String
- Definition Classes
- AnyRef → Any
- def upTo(end: Int): CounterBuilder
Set the upper bound, exclusive, except when it's Integer.MAX_VALUE, which is the default.
Set the upper bound, exclusive, except when it's Integer.MAX_VALUE, which is the default. Once it's reached, the load generator is stopped, unless
#wrapAround()is used.- end
the exclusive upper bound
- returns
a new CounterBuilder
- Annotations
- @NonNull()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def withIncrement(increment: Int): CounterBuilder
Set the gap between 2 successive values.
Set the gap between 2 successive values. Default is 1.
- increment
the gap between 2 successive values
- returns
a new CounterBuilder
- Annotations
- @NonNull()
- def wrapAround(): CounterBuilder
Start over from the first value once the upper bound is reached, instead of stopping the load generator.
Start over from the first value once the upper bound is reached, instead of stopping the load generator. Beware values are then no longer unique.
- returns
a new CounterBuilder
- Annotations
- @NonNull()