Loop
in package
Table of Contents
- $allowIteration : bool
- $context : Context
- $errorList : BSONArray
- $failureList : BSONArray
- $numIterationsEntityId : string
- $numSuccessfulOperationsEntityId : string
- $operations : array<string|int, mixed>
- $sleepUsecBetweenIterations : int
- __construct() : mixed
- allowIteration() : void
- Allow or prohibit loop operations from starting a new iteration.
- execute() : void
- setSleepUsecBetweenIterations() : void
- Set time to sleep between iterations.
- handleErrorOrFailure() : void
- initializeListEntity() : BSONArray
Properties
$allowIteration
private
static bool
$allowIteration
= true
$context
private
Context
$context
$errorList
private
BSONArray
$errorList
$failureList
private
BSONArray
$failureList
$numIterationsEntityId
private
string
$numIterationsEntityId
$numSuccessfulOperationsEntityId
private
string
$numSuccessfulOperationsEntityId
$operations
private
array<string|int, mixed>
$operations
= []
$sleepUsecBetweenIterations
private
static int
$sleepUsecBetweenIterations
= 0
Methods
__construct()
public
__construct(array<string|int, mixed> $operations, Context $context[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $operations : array<string|int, mixed>
- $context : Context
- $options : array<string|int, mixed> = []
Return values
mixed —allowIteration()
Allow or prohibit loop operations from starting a new iteration.
public
static allowIteration([bool $allowIteration = true ]) : void
This function is primarily used by the Atlas testing workload executor.
Parameters
- $allowIteration : bool = true
Return values
void —execute()
public
execute() : void
Return values
void —setSleepUsecBetweenIterations()
Set time to sleep between iterations.
public
static setSleepUsecBetweenIterations(int $usec) : void
This can be used to limit CPU usage during workload execution.
Parameters
- $usec : int
Return values
void —handleErrorOrFailure()
private
handleErrorOrFailure(Throwable $e) : void
Parameters
- $e : Throwable
Return values
void —initializeListEntity()
private
initializeListEntity(string $id) : BSONArray
Parameters
- $id : string