Renamed CONNECTION_* constants to SDB_CONNECTION_*.

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

diff --git a/src/include/frontend/connection.h b/src/include/frontend/connection.h
index bdebe7d1f9f0d3ba70222893ee73b810cec55b7a..5dc2b1a8c5ce35105f7b57b972b3dd924bca3ab8 100644 (file)
--- a/src/include/frontend/connection.h
+++ b/src/include/frontend/connection.h
@@ -29,6 +29,8 @@
 #define SDB_FRONTEND_CONNECTION_H 1
 
 #include "frontend/proto.h"
+#include "core/store.h"
+#include "utils/llist.h"
 #include "utils/strbuf.h"
 
 #include <inttypes.h>
@@ -39,6 +41,32 @@ extern "C" {
 
 typedef struct sdb_conn sdb_conn_t;
 
+/*
+ * sdb_conn_node_t represents an interface for the result of parsing a command
+ * string. The first field of an actual implementation of the interface is a
+ * sdb_conn_state_t in order to fascilitate casting to and from the interface
+ * type to the implementation type.
+ */
+typedef struct {
+       sdb_object_t super;
+       sdb_conn_state_t cmd;
+} sdb_conn_node_t;
+#define SDB_CONN_NODE(obj) ((sdb_conn_node_t *)(obj))
+
+/*
+ * sdb_connection_enable_logging:
+ * Enable logging of connection-related messages to the current client
+ * connection. After this function has been called all log messages
+ * originating from the thread handling the current client connection will
+ * also be sent to the client.
+ *
+ * Returns:
+ *  - 0 on success
+ *  - a negative value else
+ */
+int
+sdb_connection_enable_logging(void);
+
 /*
  * sdb_connection_accpet:
  * Accept a new connection on the specified file-descriptor 'fd' and return a
@@ -95,10 +123,29 @@ sdb_connection_ping(sdb_conn_t *conn);
 
 /*
  * sdb_fe_parse:
- * Parse the query text specified in 'query'.
+ * Parse the query text specified in 'query' of length 'len' and return a list
+ * of parse trees (for each command) to be executed by sdb_fe_exec. The list
+ * has to be freed by the caller. If 'len' is less than zero, parse the whole
+ * (nul-terminated) string. If specified, errbuf will be used to record parse
+ * errors.
+ *
+ * Returns:
+ *  - an sdb_llist_t object of sdb_conn_node_t on success
+ *  - NULL in case of an error
+ */
+sdb_llist_t *
+sdb_fe_parse(const char *query, int len, sdb_strbuf_t *errbuf);
+
+/*
+ * sdb_fe_exec:
+ * Execute the command identified by 'node' on the specified connection.
+ *
+ * Returns:
+ *  - 0 on success
+ *  - a negative value else
  */
 int
-sdb_fe_parse(const char *query);
+sdb_fe_exec(sdb_conn_t *conn, sdb_conn_node_t *node);
 
 /*
  * session handling
@@ -120,15 +167,80 @@ sdb_fe_session_start(sdb_conn_t *conn);
  */
 
 /*
- * sdb_fe_list:
- * Send a complete listing of the store, serialized as JSON, to the client.
+ * sdb_fe_query, sdb_fe_fetch, sdb_fe_list, sdb_fe_lookup:
+ * Handle the SDB_CONNECTION_QUERY, SDB_CONNECTION_FETCH, SDB_CONNECTION_LIST,
+ * and SDB_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 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, 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. 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, int type, sdb_store_matcher_t *filter);
+
+/*
+ * sdb_fe_exec_lookup:
+ * 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_timeseries(sdb_conn_t *conn,
+               const char *hostname, const char *metric,
+               sdb_timeseries_opts_t *opts);
 
 #ifdef __cplusplus
 } /* extern "C" */