frontend: Let the 'fetch' command support other types besides hosts.

[sysdb.git] / src / include / frontend / connection.h

diff --git a/src/include/frontend/connection.h b/src/include/frontend/connection.h
index bff3f3be7db1c2785c78c4fbcb7888d0cf914047..cbaa43ef459d1810a2bd2f84822a41487c7c33e7 100644 (file)
--- a/src/include/frontend/connection.h
+++ b/src/include/frontend/connection.h
@@ -165,46 +165,81 @@ sdb_fe_session_start(sdb_conn_t *conn);
  * 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.
  *
  * Returns:
  *  - 0 on success
  *  - a negative value else
  */
 int
-sdb_fe_exec_fetch(sdb_conn_t *conn, const char *name,
-               sdb_store_matcher_t *filter);
+sdb_fe_exec_fetch(sdb_conn_t *conn, int type,
+               const char *hostname, 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.
  *
  * 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.
+ *
+ * Returns:
+ *  - 0 on success
+ *  - a negative value else
+ */
+int
+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_lookup(sdb_conn_t *conn, sdb_store_matcher_t *m,
-               sdb_store_matcher_t *filter);
+sdb_fe_exec_timeseries(sdb_conn_t *conn,
+               const char *hostname, const char *metric,
+               sdb_timeseries_opts_t *opts);
 
 #ifdef __cplusplus
 } /* extern "C" */