ReportEndOfReplay callback

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

Syntax

_MLREPLAY_EXPORT bool _MLREPLAY_CDECL ReportEndOfReplay(
    asa_uint32 repetitionNum,
    asa_uint32 simulatedClientNum,
    bool success,
    const IMLReplayAPICallbacks * mlrAPICallbacks
)

Parameters

repetitionNum The current repetition number.
simulatedClientNum The simulated client number (ordinal 1) used to distinguish this simulated client from other simulated clients in the same mlreplay instance.
success True when the simulated client completed successfully; otherwise, false.
mlrAPICallbacks Callbacks to provide information from mlreplay that can be used to customize replay behavior.

Remarks

You can use this callback 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.