Group dataprovider¶

Classes¶

Type	Name
struct	tirexDataProvider_st Contains information about a data provider.

Public Types¶

Type	Name
typedef struct tirexDataProvider_st	tirexDataProvider Contains information about a data provider.

Public Functions¶

Type	Name
TIREX_TRACKER_EXPORT size_t	tirexDataProviderGetAll (tirexDataProvider * providers, size_t bufsize) Populates the given buffer with all available providers (or at most `bufsize` if`buf` is not large enugh) and returns the total number of available providers.

Detailed Description¶

Methods and definitions necessary to fetch information about the underlying data sources. Dataproviders are the underlying mechanism for collecting the requested metadata and are abstracted away by the API. The following definitions can be used to get more information (e.g., to report detailed version information).

Public Types Documentation¶

typedef tirexDataProvider¶

Contains information about a data provider.

typedef struct tirexDataProvider_st tirexDataProvider;

Data providers are modules tasked with collecting associated metrics about the program.

Public Functions Documentation¶

function tirexDataProviderGetAll¶

Populates the given buffer with all available providers (or at most bufsize ifbuf is not large enugh) and returns the total number of available providers.

TIREX_TRACKER_EXPORT size_t tirexDataProviderGetAll (
    tirexDataProvider * providers,
    size_t bufsize
)

If buf is NULL , bufsize is ignored and only the number of available providers are returned. A typical call may look as follows:

size_t num = tirexDataProviderGetAll(NULL, 0);
struct tirexDataProvider* buf = (struct tirexDataProvider*)calloc(num, sizeof(struct tirexDataProvider));
tirexDataProviderGetAll(buf, num);
// ...
free(buf);

Parameters:

providers
bufsize

Returns:

The number of available data providers.