 |
1.2 (revision 3183)
|
|
1.2 (revision 3183)
|
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_MarkerReaderCallbacks * | OTF2_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. | |
This defines the callbacks for the marker reader.
| 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.
| userData | User data as set by OTF2_Reader_RegisterMarkerCallbacks or OTF2_MarkerReader_SetCallbacks. |
| self | Reference to this marker defintion. |
| markerGroup | Group name, e.g., "MUST", ... |
| markerCategory | Category, e.g., "Argument type error", ... The tuple (markerGroup, markerCategory) must be unique over all marker definitions. |
| severity | The severity for this marker category. |
| 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.
| userData | User data as set by OTF2_Reader_RegisterMarkerCallbacks or OTF2_MarkerReader_SetCallbacks. |
| timestamp | Timestamp of the marker. |
| duration | Duration the marker applies. |
| marker | Reference to the marker defintion. |
| scope | The type of scope of this marker instance. |
| scopeRef | The reference to an element of the scope of this marker. Depends on scope. |
| text | A textual description for this marker. |
| typedef OTF2_CallbackCode( * OTF2_MarkerReaderCallback_Unknown)(void *userData) |
Function pointer definition for the callback which is triggered for an unknown marker.
| userData | User data as set by OTF2_Reader_RegisterMarkerCallbacks or OTF2_MarkerReader_SetCallbacks. |
| void OTF2_MarkerReaderCallbacks_Clear | ( | OTF2_MarkerReaderCallbacks * | markerReaderCallbacks | ) |
Clears a struct for the marker callbacks.
| markerReaderCallbacks | Handle to a struct previously allocated with OTF2_MarkerReaderCallbacks_New. |
| void OTF2_MarkerReaderCallbacks_Delete | ( | OTF2_MarkerReaderCallbacks * | markerReaderCallbacks | ) |
Deallocates a struct for the marker callbacks.
| markerReaderCallbacks | Handle to a struct previously allocated with OTF2_MarkerReaderCallbacks_New. |
| OTF2_MarkerReaderCallbacks* OTF2_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.
| markerReaderCallbacks | Struct for all callbacks. |
| defMarkerCallback | Function which should be called for all Marker definitions. |
if successful
for an invalid defReaderCallbacks argument
| OTF2_ErrorCode OTF2_MarkerReaderCallbacks_SetMarkerCallback | ( | OTF2_MarkerReaderCallbacks * | markerReaderCallbacks, |
| OTF2_MarkerReaderCallback_Marker | markerCallback | ||
| ) |
Registers the callback for the Marker record.
| markerReaderCallbacks | Struct for all callbacks. |
| markerCallback | Function which should be called for all Marker records. |
if successful
for an invalid defReaderCallbacks argument
| OTF2_ErrorCode OTF2_MarkerReaderCallbacks_SetUnknownCallback | ( | OTF2_MarkerReaderCallbacks * | markerReaderCallbacks, |
| OTF2_MarkerReaderCallback_Unknown | unknownCallback | ||
| ) |
Registers the callback for an unknown marker.
| markerReaderCallbacks | Struct for all callbacks. |
| unknownCallback | Function which should be called for all unknown definitions. |
if successful
for an invalid defReaderCallbacks argument