3.0-rc2 (revision 337012f1)
|
This is the global event reader. More...
#include <stdint.h>
#include <otf2/OTF2_ErrorCodes.h>
#include <otf2/OTF2_EvtReader.h>
#include <otf2/OTF2_GlobalEvtReaderCallbacks.h>
Go to the source code of this file.
Functions | |
OTF2_ErrorCode | OTF2_GlobalEvtReader_SetCallbacks (OTF2_GlobalEvtReader *reader, const OTF2_GlobalEvtReaderCallbacks *callbacks, void *userData) |
Sets the callback functions for the given reader object. Every time when OTF2 reads a record, a callback function is called and the records data is passed to this function. Therefore the programmer needs to set function pointers at the "callbacks" struct for the record type he wants to read. More... | |
OTF2_ErrorCode | OTF2_GlobalEvtReader_ReadEvent (OTF2_GlobalEvtReader *reader) |
Triggers the callback for the next event record. More... | |
OTF2_ErrorCode | OTF2_GlobalEvtReader_HasEvent (OTF2_GlobalEvtReader *reader, int *flag) |
Has more events. More... | |
OTF2_ErrorCode | OTF2_GlobalEvtReader_ReadEvents (OTF2_GlobalEvtReader *reader, uint64_t recordsToRead, uint64_t *recordsRead) |
Reads the given number of records from the global event reader. More... | |
This is the global event reader.
Used to read from multiple local event readers, and provide them in a timely ordered sequence.
OTF2_ErrorCode OTF2_GlobalEvtReader_SetCallbacks | ( | OTF2_GlobalEvtReader * | reader, |
const OTF2_GlobalEvtReaderCallbacks * | callbacks, | ||
void * | userData | ||
) |
Sets the callback functions for the given reader object. Every time when OTF2 reads a record, a callback function is called and the records data is passed to this function. Therefore the programmer needs to set function pointers at the "callbacks" struct for the record type he wants to read.
reader | Reader object which reads the events from its buffer. |
callbacks | Struct which holds a function pointer for each record type. OTF2_GlobalEvtReaderCallbacks_New. |
userData | Data passed as argument userData to the record callbacks. |
OTF2_ErrorCode OTF2_GlobalEvtReader_ReadEvent | ( | OTF2_GlobalEvtReader * | reader | ) |
Triggers the callback for the next event record.
reader | Reader object which reads the events from its buffer. |
OTF2_ErrorCode OTF2_GlobalEvtReader_HasEvent | ( | OTF2_GlobalEvtReader * | reader, |
int * | flag | ||
) |
Has more events.
reader | Global event reader handle. | |
[out] | flag | In case of success, the flag will be set to 1 when there is at least more more event to read. To 0 if not. Otherwise the value is undefined. |
OTF2_ErrorCode OTF2_GlobalEvtReader_ReadEvents | ( | OTF2_GlobalEvtReader * | reader, |
uint64_t | recordsToRead, | ||
uint64_t * | recordsRead | ||
) |
Reads the given number of records from the global event reader.
reader | The records of this reader will be read when the function is issued. | |
recordsToRead | This variable tells the reader how much records it has to read. | |
[out] | recordsRead | This is a pointer to variable where the amount of actually read records is returned. This may differ to the given recordsToRead if there are no more records left in the trace. In this case the programmer can easily check that the reader has finished his job by checking recordsRead < recordsToRead. |