plugin: Added sdb_plugin_fetch_timeseries().

[sysdb.git] / src / include / core / plugin.h

diff --git a/src/include/core/plugin.h b/src/include/core/plugin.h
index 4ccc983c446551db07ec729b4c7b26cfc8161b8b..0dce87705fb5cb5793c2b7500fd774dae18ec910 100644 (file)
--- a/src/include/core/plugin.h
+++ b/src/include/core/plugin.h
@@ -377,6 +377,22 @@ sdb_plugin_vlogf(int prio, const char *fmt, va_list ap);
 int
 sdb_plugin_logf(int prio, const char *fmt, ...);
 
+/*
+ * sdb_plugin_fetch_timeseries:
+ * Fetch the time-series identified by 'id' from a backend data-store of the
+ * specified 'type'. The type has to match an existing time-series fetcher
+ * callback's name. The identifier is passed through to the callback which
+ * then needs to make sense of it. The time-series option specify which data
+ * to fetch.
+ *
+ * Returns:
+ *  - a time-series on success
+ *  - NULL else
+ */
+sdb_timeseries_t *
+sdb_plugin_fetch_timeseries(const char *type, const char *id,
+               sdb_timeseries_opts_t *opts);
+
 #ifdef __cplusplus
 } /* extern "C" */
 #endif