cohtml::IProfileMarkersTracer

#include <Library.h>

Public Functions #

Public Functions Documentation #

function IProfileMarkersTracer #

IProfileMarkersTracer()

function ~IProfileMarkersTracer #

virtual ~IProfileMarkersTracer()

function BeginTraceEvent #

virtual void BeginTraceEvent(
    const char * system,
    const char * markerName
) =0

Start a scoped profiling marker.

Parameters:

• system Name of the Cohtml’s subsystem from where the profling event is emmited
• markerName The name of the marker that is started

function BeginTraceEventWithString #

virtual void BeginTraceEventWithString(
    const char * system,
    const char * markerName,
    const char * valueName,
    const char * value
) =0

Start a scoped profiling marker with a string data attached to it.

Parameters:

• system Name of the Cohtml’s subsystem from where the profling event is emmited
• markerName The name of the marker that is started
• valueName Name of the string variable for the event
• value The value of the string variable

function BeginTraceEventWithInt #

virtual void BeginTraceEventWithInt(
    const char * system,
    const char * markerName,
    const char * valueName,
    int value
) =0

Start a scoped profiling marker with a integer data attached to it.

Parameters:

• system Name of the Cohtml’s subsystem from where the profling event is emmited
• markerName The name of the marker that is started
• valueName Name of the integer variable for the event
• value The value of the integer variable

function EndTraceEvent #

virtual void EndTraceEvent(
    const char * system,
    const char * markerName
) =0

End a scoped profiling marker.

Parameters:

• system Name of the Cohtml’s subsystem from where the profling event is emmited
• markerName The name of the marker that is started

function BeginTraceEventAsync #

virtual void BeginTraceEventAsync(
    const char * system,
    const char * markerName,
    void * id
) =0

Start a profiling event that can be started and ended on different threads.

Parameters:

• system Name of the Cohtml’s subsystem from where the profling event is emmited
• markerName The name of the marker that is started
• id Unique pointer that can be used toidentify the event

function EndTraceEventAsync #

virtual void EndTraceEventAsync(
    const char * system,
    const char * markerName,
    void * id
) =0

End a profiling event that can be started and ended on different threads.

Parameters:

• system Name of the Cohtml’s subsystem from where the profling event is emmited
• markerName The name of the marker that is started
• id Unique pointer that can be used toidentify the event

function InstantTraceEvent #

virtual void InstantTraceEvent(
    const char * system,
    const char * markerName
) =0

Emit a simple event that does not have starting and beginning point.

Parameters:

• system Name of the Cohtml’s subsystem from where the event is emmited
• markerName The name of the marker that is emmited

function InstantTraceEventWithInt #

virtual void InstantTraceEventWithInt(
    const char * system,
    const char * markerName,
    const char * valueName,
    int value
) =0

Emit a simple event that does not have starting and beginning point and has some integer data attached to it.

Parameters:

• system Name of the Cohtml’s subsystem from where the event is emmited
• markerName The name of the marker that is emmited
• valueName Name of the integer variable for the event
• value The value of the integer variable

function UpdateCounter #

virtual void UpdateCounter(
    const char * name,
    int value
) =0

Update a profilng counter with a value. Most of the time, those are different memory counters for various subsystems of Cohtml.

Parameters:

• name The name of the counter
• value The new value of the counter

function HintThreadName #

virtual void HintThreadName(
    const char * name
) =0

Hint on which thread is Cohtml currently emmiting events.

Parameters:

• name The name of the thread