1.2 (revision 3183)
Typedefs | Functions

OTF2_MarkerReaderCallbacks.h File Reference

This defines the callbacks for the marker reader. More...

#include <stdint.h>
#include <otf2/OTF2_ErrorCodes.h>
#include <otf2/OTF2_GeneralDefinitions.h>
#include <otf2/OTF2_Definitions.h>
#include <otf2/OTF2_IdMap.h>
#include <otf2/OTF2_Marker.h>

Go to the source code of this file.

Typedefs

typedef OTF2_CallbackCode(* OTF2_MarkerReaderCallback_DefMarker )(void *userData, OTF2_MarkerRef self, const char *markerGroup, const char *markerCategory, OTF2_MarkerSeverity severity)
 Function pointer definition for the callback which is triggered by a Marker definition record.
typedef OTF2_CallbackCode(* OTF2_MarkerReaderCallback_Marker )(void *userData, OTF2_TimeStamp timestamp, OTF2_TimeStamp duration, OTF2_MarkerRef marker, OTF2_MarkerScope scope, uint64_t scopeRef, const char *text)
 Function pointer definition for the callback which is triggered by a Marker record.
typedef OTF2_CallbackCode(* OTF2_MarkerReaderCallback_Unknown )(void *userData)
 Function pointer definition for the callback which is triggered for an unknown marker.
typedef struct
OTF2_MarkerReaderCallbacks_struct 
OTF2_MarkerReaderCallbacks
 Opaque struct which holdes all definition record callbacks.

Functions

void OTF2_MarkerReaderCallbacks_Clear (OTF2_MarkerReaderCallbacks *markerReaderCallbacks)
 Clears a struct for the marker callbacks.
void OTF2_MarkerReaderCallbacks_Delete (OTF2_MarkerReaderCallbacks *markerReaderCallbacks)
 Deallocates a struct for the marker callbacks.
OTF2_MarkerReaderCallbacksOTF2_MarkerReaderCallbacks_New (void)
 Allocates a new struct for the marker callbacks.
OTF2_ErrorCode OTF2_MarkerReaderCallbacks_SetDefMarkerCallback (OTF2_MarkerReaderCallbacks *markerReaderCallbacks, OTF2_MarkerReaderCallback_DefMarker defMarkerCallback)
 Registers the callback for the Marker definition.
OTF2_ErrorCode OTF2_MarkerReaderCallbacks_SetMarkerCallback (OTF2_MarkerReaderCallbacks *markerReaderCallbacks, OTF2_MarkerReaderCallback_Marker markerCallback)
 Registers the callback for the Marker record.
OTF2_ErrorCode OTF2_MarkerReaderCallbacks_SetUnknownCallback (OTF2_MarkerReaderCallbacks *markerReaderCallbacks, OTF2_MarkerReaderCallback_Unknown unknownCallback)
 Registers the callback for an unknown marker.

Detailed Description

This defines the callbacks for the marker reader.


Typedef Documentation

typedef OTF2_CallbackCode( * OTF2_MarkerReaderCallback_DefMarker)(void *userData, OTF2_MarkerRef self, const char *markerGroup, const char *markerCategory, OTF2_MarkerSeverity severity)

Function pointer definition for the callback which is triggered by a Marker definition record.

Parameters:
userDataUser data as set by OTF2_Reader_RegisterMarkerCallbacks or OTF2_MarkerReader_SetCallbacks.
selfReference to this marker defintion.
markerGroupGroup name, e.g., "MUST", ...
markerCategoryCategory, e.g., "Argument type error", ... The tuple (markerGroup, markerCategory) must be unique over all marker definitions.
severityThe severity for this marker category.
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_MarkerReaderCallback_Marker)(void *userData, OTF2_TimeStamp timestamp, OTF2_TimeStamp duration, OTF2_MarkerRef marker, OTF2_MarkerScope scope, uint64_t scopeRef, const char *text)

Function pointer definition for the callback which is triggered by a Marker record.

Parameters:
userDataUser data as set by OTF2_Reader_RegisterMarkerCallbacks or OTF2_MarkerReader_SetCallbacks.
timestampTimestamp of the marker.
durationDuration the marker applies.
markerReference to the marker defintion.
scopeThe type of scope of this marker instance.
scopeRefThe reference to an element of the scope of this marker. Depends on scope.
textA textual description for this marker.
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.

Function pointer definition for the callback which is triggered for an unknown marker.

Parameters:
userDataUser data as set by OTF2_Reader_RegisterMarkerCallbacks or OTF2_MarkerReader_SetCallbacks.
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.

Function Documentation

void OTF2_MarkerReaderCallbacks_Clear ( OTF2_MarkerReaderCallbacks markerReaderCallbacks)

Clears a struct for the marker callbacks.

Since:
Version 1.2
Parameters:
markerReaderCallbacksHandle to a struct previously allocated with OTF2_MarkerReaderCallbacks_New.
void OTF2_MarkerReaderCallbacks_Delete ( OTF2_MarkerReaderCallbacks markerReaderCallbacks)

Deallocates a struct for the marker callbacks.

Since:
Version 1.2
Parameters:
markerReaderCallbacksHandle to a struct previously allocated with OTF2_MarkerReaderCallbacks_New.
OTF2_MarkerReaderCallbacks* OTF2_MarkerReaderCallbacks_New ( void  )

Allocates a new struct for the marker callbacks.

Since:
Version 1.2
Returns:
A newly allocated struct of type OTF2_MarkerReaderCallbacks.
OTF2_ErrorCode OTF2_MarkerReaderCallbacks_SetDefMarkerCallback ( OTF2_MarkerReaderCallbacks markerReaderCallbacks,
OTF2_MarkerReaderCallback_DefMarker  defMarkerCallback 
)

Registers the callback for the Marker definition.

Parameters:
markerReaderCallbacksStruct for all callbacks.
defMarkerCallbackFunction which should be called for all Marker definitions.
Since:
Version 1.2
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_MarkerReaderCallbacks_SetMarkerCallback ( OTF2_MarkerReaderCallbacks markerReaderCallbacks,
OTF2_MarkerReaderCallback_Marker  markerCallback 
)

Registers the callback for the Marker record.

Parameters:
markerReaderCallbacksStruct for all callbacks.
markerCallbackFunction which should be called for all Marker records.
Since:
Version 1.2
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_MarkerReaderCallbacks_SetUnknownCallback ( OTF2_MarkerReaderCallbacks markerReaderCallbacks,
OTF2_MarkerReaderCallback_Unknown  unknownCallback 
)

Registers the callback for an unknown marker.

Parameters:
markerReaderCallbacksStruct for all callbacks.
unknownCallbackFunction which should be called for all unknown definitions.
Since:
Version 1.2
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument