DelayCreationOfSimulatedClient callback

Coordinates when the simulated clients are created.

Syntax

bool _callback DelayCreationOfSimulatedClient(
    asa_uint32 numRepetitions,
    asa_uint32 simulatedClientNum,
    asa_uint32 numSimulatedClients,
    const MLReplayNamesAndValues * namesAndValues
)

Parameters

numRepetitions The number of times to repeat the session, which is always 1.
simulatedClientNum The simulated client number (ordinal 1) used to distinguish this simulated client from other simulated clients in the same mlreplay instance.
numSimulatedClients The total number of simulated clients in this mlreplay instance.
namesAndValues The set of defined names and values used to customize replay behavior.

Remarks

Simulated client X is created under the following conditions:

DelayCreationOfSimulatedClient returned for simulated clients 1, ..., X - 1.
DelayCreationOfSimulatedClient( X, numSimulatedClients, namesAndValues ) returns true.

The simulated client is not created when this callback returns false and additional simulated clients are still created. This callback is called once per simulated client per mlreplay instance.

Discuss this page in DocCommentXchange.