ReportEndOfReplay callback

Used to perform any actions required when a simulated client is finished replaying; called once per simulated client, and per repetition.

Syntax

bool _callback ReportEndOfReplay(
    asa_uint32 repetitionNum,
    asa_uint32 numRepetitions,
    asa_uint32 simulatedClientNum,
    asa_uint32 numSimulatedClients,
    bool success,
    const MLReplayNamesAndValues * namesAndValues
)

Parameters

repetitionNum The current repetition number.
numRepetitions The number of times to repeat the session.
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.
success True when the simulated client completed successfully; otherwise, false.
namesAndValues The set of defined names and values used to customize replay behavior.

This callback is called once per repetition, per simulated client, per mlreplay instance. It can be used to perform operations required when a replay is finished; for example, you can use it to ensure that data was uploaded correctly in repetition X.

This callback determines the result of the given replay. If success is false, then this callback has no affect on the success of the replay. If success is true but this callback returns false, then mlreplay treats the simulated client as if it failed for the specified repetition. This callback can be called concurrently.

Discuss this page in DocCommentXchange.