OpenMPI  0.1.1
OTF_RStream.h File Reference

Provides read access to trace streams, which consist of multiple buffers. More...

#include <stdlib.h>
#include <string.h>
#include <stdio.h>
#include "OTF_inttypes.h"
#include "OTF_FileManager.h"
#include "OTF_RBuffer.h"
#include "OTF_Filenames.h"
#include "OTF_HandlerArray.h"

Go to the source code of this file.

Data Structures

struct  struct_OTF_RStream
 

Typedefs

typedef struct struct_OTF_RStream OTF_RStream
 rstream object
 

Functions

OTF_RStreamOTF_RStream_open (const char *nameStub, uint32_t id, OTF_FileManager *manager)
 Create a new OTF_RStream instance. More...
 
int OTF_RStream_close (OTF_RStream *rstream)
 Close an OTF_RStream instance and all its related files. More...
 
OTF_RBufferOTF_RStream_getDefBuffer (OTF_RStream *rstream)
 Returns the definition buffer of the according reader stream. More...
 
OTF_RBufferOTF_RStream_setDefBuffer (OTF_RStream *rstream, OTF_RBuffer *rbuffer)
 Forces the given definition buffer to the according reader stream. More...
 
int OTF_RStream_closeDefBuffer (OTF_RStream *rstream)
 Closes the stream definition buffer. More...
 
OTF_RBufferOTF_RStream_getEventBuffer (OTF_RStream *rstream)
 Returns the event buffer of the according reader stream. More...
 
int OTF_RStream_closeEventBuffer (OTF_RStream *rstream)
 Closes the stream event buffer. More...
 
OTF_RBufferOTF_RStream_getSnapsBuffer (OTF_RStream *rstream)
 Returns the snapshots buffer of the according reader stream. More...
 
int OTF_RStream_closeSnapsBuffer (OTF_RStream *rstream)
 Closes the stream snapshots buffer. More...
 
OTF_RBufferOTF_RStream_getStatsBuffer (OTF_RStream *rstream)
 Returns the statistics buffer of the according reader stream. More...
 
int OTF_RStream_closeStatsBuffer (OTF_RStream *rstream)
 Closes the stream statistics buffer. More...
 
OTF_RBufferOTF_RStream_getMarkerBuffer (OTF_RStream *rstream)
 Returns the marker buffer of the according reader stream. More...
 
int OTF_RStream_closeMarkerBuffer (OTF_RStream *rstream)
 Closes the stream marker buffer. More...
 
void OTF_RStream_setBufferSizes (OTF_RStream *rstream, uint32_t size)
 Set the default buffer size for all buffers managed by this reader stream. More...
 
uint32_t OTF_RStream_getBufferSizes (OTF_RStream *rstream)
 Get the default buffer size for all buffers managed by this reader stream. More...
 
void OTF_RStream_setZBufferSizes (OTF_RStream *rstream, uint32_t size)
 Set the default zbuffer size for all files managed by this reader stream. More...
 
uint32_t OTF_RStream_getZBufferSizes (OTF_RStream *rstream)
 Get the default zbuffer size for all files managed by this reader stream. More...
 
void OTF_RStream_setRecordLimit (OTF_RStream *rstream, uint64_t limit)
 Sets the maximum number of records delivered by a single call to OTF_RStream_readXYZ(). More...
 
uint64_t OTF_RStream_getRecordLimit (OTF_RStream *rstream)
 Returns the current record limit. More...
 
uint64_t OTF_RStream_readDefinitions (OTF_RStream *rstream, OTF_HandlerArray *handlers)
 Reads all definitions from the stream. More...
 
uint64_t OTF_RStream_readEvents (OTF_RStream *rstream, OTF_HandlerArray *handlers)
 Reads all events from the stream and calls the appropriated handler sorted by time. More...
 
uint64_t OTF_RStream_readSnapshots (OTF_RStream *rstream, OTF_HandlerArray *handlers)
 Reads all snapshots from the stream. More...
 
uint64_t OTF_RStream_readStatistics (OTF_RStream *rstream, OTF_HandlerArray *handlers)
 Reads all statistics from the stream. More...
 
uint64_t OTF_RStream_readMarker (OTF_RStream *rstream, OTF_HandlerArray *handlers)
 Reads all markers from the stream. More...
 
uint8_t OTF_RStream_eventProgress (OTF_RStream *rstream, uint64_t *minimum, uint64_t *current, uint64_t *maximum)
 depricated. More...
 
uint8_t OTF_RStream_snapshotProgress (OTF_RStream *rstream, uint64_t *minimum, uint64_t *current, uint64_t *maximum)
 depricated. More...
 
uint8_t OTF_RStream_statisticProgress (OTF_RStream *rstream, uint64_t *minimum, uint64_t *current, uint64_t *maximum)
 depricated. More...
 
uint8_t OTF_RStream_eventTimeProgress (OTF_RStream *rstream, uint64_t *minimum, uint64_t *current, uint64_t *maximum)
 Delivers a progress report for reading events. More...
 
uint8_t OTF_RStream_snapshotTimeProgress (OTF_RStream *rstream, uint64_t *minimum, uint64_t *current, uint64_t *maximum)
 Delivers a progress report for reading snapshots. More...
 
uint8_t OTF_RStream_statisticTimeProgress (OTF_RStream *rstream, uint64_t *minimum, uint64_t *current, uint64_t *maximum)
 Delivers a progress report for reading statistics. More...
 
uint8_t OTF_RStream_eventBytesProgress (OTF_RStream *rstream, uint64_t *minimum, uint64_t *current, uint64_t *maximum)
 Delivers a progress report for reading events. More...
 
uint8_t OTF_RStream_snapshotBytesProgress (OTF_RStream *rstream, uint64_t *minimum, uint64_t *current, uint64_t *maximum)
 Delivers a progress report for reading snapshots. More...
 
uint8_t OTF_RStream_statisticBytesProgress (OTF_RStream *rstream, uint64_t *minimum, uint64_t *current, uint64_t *maximum)
 Delivers a progress report for reading statistics. More...
 

Detailed Description

Provides read access to trace streams, which consist of multiple buffers.