3.0-rc2 (revision 337012f1)
OTF2_MarkerReader.h
Go to the documentation of this file.
1 /*
2  * This file is part of the Score-P software (http://www.score-p.org)
3  *
4  * Copyright (c) 2013,
5  * Technische Universitaet Dresden, Germany
6  *
7  * This software may be modified and distributed under the terms of
8  * a BSD-style license. See the COPYING file in the package base
9  * directory for details.
10  */
11 
12 
13 #ifndef OTF2_MARKER_READER_H
14 #define OTF2_MARKER_READER_H
15 
16 
24 #include <stdint.h>
25 
26 
27 #include <otf2/OTF2_ErrorCodes.h>
28 
29 
30 #include <otf2/OTF2_Marker.h>
32 
33 
34 #ifdef __cplusplus
35 extern "C" {
36 #endif /* __cplusplus */
37 
38 
58  uint64_t recordsToRead,
59  uint64_t* recordsRead );
60 
61 
81  const OTF2_MarkerReaderCallbacks* callbacks,
82  void* userData );
83 
84 
85 #ifdef __cplusplus
86 }
87 #endif /* __cplusplus */
88 
89 
90 #endif /* !OTF2_MARKER_READER_H */
struct OTF2_MarkerReader_struct OTF2_MarkerReader
OTF2 marker reader handle.
Definition: OTF2_GeneralDefinitions.h:271
This defines the callbacks for the marker reader.
OTF2_ErrorCode
Definition: OTF2_ErrorCodes.h:54
OTF2_ErrorCode OTF2_MarkerReader_ReadMarkers(OTF2_MarkerReader *reader, uint64_t recordsToRead, uint64_t *recordsRead)
After callback registration, the markers could be read with the following function. The user of this function tells the system how many markers it is able to handle (recordsToRead) and the function returns how many markers where in the stream (recordsRead). It should usually be the case that both values are the same. If this is not the case, then there where less records than requested in the stream.
OTF2_ErrorCode OTF2_MarkerReader_SetCallbacks(OTF2_MarkerReader *reader, const OTF2_MarkerReaderCallbacks *callbacks, void *userData)
Sets the callback functions for the given reader object. Every time when OTF2 reads a record...
This file provides types and enums for markers.
struct OTF2_MarkerReaderCallbacks_struct OTF2_MarkerReaderCallbacks
Opaque struct which holds all definition record callbacks.
Definition: OTF2_MarkerReaderCallbacks.h:45
Error codes and error handling.