index bff3f3be7db1c2785c78c4fbcb7888d0cf914047..a890bd0ffae75d16fa1e39909c12fb5c0621d86b 100644 (file)
* store access
*/
+/*
+ * sdb_fe_query, sdb_fe_fetch, sdb_fe_list, sdb_fe_lookup:
+ * Handle the CONNECTION_QUERY, CONNECTION_FETCH, CONNECTION_LIST, and
+ * CONNECTION_LOOKUP commands respectively. It is expected that the current
+ * command has been initialized already.
+ *
+ * Returns:
+ * - 0 on success
+ * - a negative value else
+ */
+int
+sdb_fe_query(sdb_conn_t *conn);
+int
+sdb_fe_fetch(sdb_conn_t *conn);
+int
+sdb_fe_list(sdb_conn_t *conn);
+int
+sdb_fe_lookup(sdb_conn_t *conn);
+
/*
* sdb_fe_exec_fetch:
- * Execute the 'FETCH' command. Send the named host, serialized as JSON, to
- * the client. If specified, only objects matching the filter will be
- * included. See sdb_store_tojson for details.
+ * Execute the 'FETCH' command. Send the named object of the specified type,
+ * serialized as JSON, to the client. If specified, only objects matching the
+ * filter will be included. See sdb_store_tojson for details.
*
* Returns:
* - 0 on success
* - a negative value else
*/
int
-sdb_fe_exec_fetch(sdb_conn_t *conn, const char *name,
+sdb_fe_exec_fetch(sdb_conn_t *conn, int type, const char *name,
sdb_store_matcher_t *filter);
/*
* sdb_fe_exec_list:
* Execute the 'LIST' command. Send a complete listing of the store,
- * serialized as JSON, to the client. If specified, only objects matching the
- * filter will be included. See sdb_store_tojson for details.
+ * serialized as JSON, to the client. The listing includes all hosts and the
+ * specified object type. If specified, only objects matching the filter will
+ * be included. See sdb_store_tojson for details.
*
* Returns:
* - 0 on success
* - a negative value else
*/
int
-sdb_fe_exec_list(sdb_conn_t *conn, sdb_store_matcher_t *filter);
+sdb_fe_exec_list(sdb_conn_t *conn, int type, sdb_store_matcher_t *filter);
/*
* sdb_fe_exec_lookup:
- * Execute the 'LOOKUP' command. Send a list of hosts matching 'm', serialized
- * as JSON, to the client. If specified, only objects matching the filter will
- * be included. See sdb_store_tojson for details.
+ * Execute the 'LOOKUP' command. Send a list of objects of the specified type
+ * matching 'm', serialized as JSON, to the client. If specified, only objects
+ * matching the filter will be included. See sdb_store_tojson for details.
*
* Returns:
* - 0 on success
* - a negative value else
*/
int
-sdb_fe_exec_lookup(sdb_conn_t *conn, sdb_store_matcher_t *m,
- sdb_store_matcher_t *filter);
+sdb_fe_exec_lookup(sdb_conn_t *conn, int type,
+ sdb_store_matcher_t *m, sdb_store_matcher_t *filter);
+
+/*
+ * sdb_fe_exec_timeseries:
+ * Execute the 'TIMESERIES' command. Send the time-series for the specified
+ * host's metric, serialized as JSON, to the client. See
+ * sdb_store_fetch_timeseries for details.
+ *
+ * Returns:
+ * - 0 on success
+ * - a negative value else
+ */
+int
+sdb_fe_exec_timeseries(sdb_conn_t *conn,
+ const char *hostname, const char *metric,
+ sdb_timeseries_opts_t *opts);
#ifdef __cplusplus
} /* extern "C" */