allinea_metric_plugin_errors.h File Reference

Functions for reporting errors encountered by a metric plugin library or specific metric.

#include <stdint.h>
#include <stdlib.h>
#include <time.h>
#include "allinea_metric_plugin_types.h

Include dependency graph for allinea_metric_plugin_errors.h:

This graph shows which files directly or indirectly include this file:

allinea_metric_plugin_errors_8h_dep_incl

Source code

1
5 #ifndef ALLINEA_METRIC_PLUGIN_ERRORS_H
6 #define ALLINEA_METRIC_PLUGIN_ERRORS_H
7
8 #include <stdint.h>
9 #include <stdlib.h>
10 #include <time.h>
11
12 #include "allinea_metric_plugin_types.h"
13
14 #ifdef __cplusplus
15 extern "C" {
16 #endif
17
23
49 void allinea_set_plugin_error_message(plugin_id_t plugin_id, int error_code, const char *error_message);
50
52
78 void allinea_set_plugin_error_messagef(plugin_id_t plugin_id, int error_code, const char *error_message, ...);
79
81
98 void allinea_set_metric_error_message(metric_id_t metric_id, int error_code, const char *error_message);
99
101
123 void allinea_set_metric_error_messagef(metric_id_t metric_id, int error_code, const char *error_message, ...);
124
125
127
128 #ifdef __cplusplus
129 }
130 #endif
131
132 #endif // ALLINEA_METRIC_PLUGIN_ERRORS_H

Error reporting functions

Functions for reporting errors encountered by either a specific metric or an entire metric plugin library.

void allinea_set_plugin_error_message() (plugin_id_t plugin_id, int error_code, const char * error_message): Reports an error that occurred in the plugin (group of metrics).
void allinea_set_plugin_error_messagef() (plugin_id_t plugin_id, int error_code, const char * error_message,...): Reports an error occurred in the plugin (group of metrics).
void allinea_set_metric_error_message() (metric_id_t metric_id, int error_code, const char * error_message): Reports an error occurred when reading a metric.
void allinea_set_metric_error_messagef() (metric_id_t metric_id, int error_code, const char * error_message,...): Reports an error occurred when reading a metric.

See also * Error reporting functions * metric_id_t