OTF2_GlobalDefReader.h File Reference

This is the definition reader. More...

#include <stddef.h>
#include <stdint.h>
#include <otf2/OTF2_ErrorCodes.h>
#include <otf2/OTF2_Definitions.h>
#include <otf2/OTF2_GlobalDefReaderCallbacks.h>

Go to the source code of this file.

Functions
OTF2_ErrorCode	OTF2_GlobalDefReader_SetCallbacks (OTF2_GlobalDefReader *reader, const OTF2_GlobalDefReaderCallbacks *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_GlobalDefReader_ReadDefinitions (OTF2_GlobalDefReader *reader, uint64_t recordsToRead, uint64_t *recordsRead)
	Reads the given number of records from the global definition reader. More...

Detailed Description

This is the definition reader.

Function Documentation

OTF2_ErrorCode OTF2_GlobalDefReader_SetCallbacks	(	OTF2_GlobalDefReader *	reader,
		const OTF2_GlobalDefReaderCallbacks *	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.

Parameters

reader	This given reader object will be set up with new callback functions.
callbacks	Struct which holds a function pointer for each record type. OTF2_GlobalDefReaderCallbacks_New.
userData	Data passed as argument userData to the record callbacks.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_GlobalDefReader_ReadDefinitions	(	OTF2_GlobalDefReader *	reader,
		uint64_t	recordsToRead,
		uint64_t *	recordsRead
	)

Reads the given number of records from the global definition reader.

Parameters

	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.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.