frontend: Drop sdb_fe_exec_* in favor of sdb_store_query_execute.

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

diff --git a/src/include/frontend/connection.h b/src/include/frontend/connection.h
index 906f906acbea436c5518dd84e798145a84b4d5ac..04e7d8df2ca6b9f0003de8a07499caf8e3a793bd 100644 (file)
--- a/src/include/frontend/connection.h
+++ b/src/include/frontend/connection.h
@@ -32,6 +32,7 @@
 #include "core/store.h"
 #include "utils/llist.h"
 #include "utils/strbuf.h"
+#include "utils/proto.h"
 
 #include <inttypes.h>
 
@@ -57,6 +58,12 @@ typedef struct {
 } sdb_conn_node_t;
 #define SDB_CONN_NODE(obj) ((sdb_conn_node_t *)(obj))
 
+/*
+ * sdb_conn_setup_cb is a callback function used to setup a connection. For
+ * example, it may be used to initialize session information.
+ */
+typedef int (*sdb_conn_setup_cb)(sdb_conn_t *, void *);
+
 /*
  * sdb_connection_enable_logging:
  * Enable logging of connection-related messages to the current client
@@ -74,14 +81,16 @@ sdb_connection_enable_logging(void);
 /*
  * sdb_connection_accpet:
  * Accept a new connection on the specified file-descriptor 'fd' and return a
- * newly allocated connection object.
+ * newly allocated connection object. If specified, the setup callback is used
+ * to setup the newly created connection. It will receive the connection
+ * object and the specified user data as its arguments.
  *
  * Returns:
  *  - 0 on success
  *  - a negative value else
  */
 sdb_conn_t *
-sdb_connection_accept(int fd);
+sdb_connection_accept(int fd, sdb_conn_setup_cb setup, void *user_data);
 
 /*
  * sdb_connection_close:
@@ -126,13 +135,23 @@ sdb_connection_send(sdb_conn_t *conn, uint32_t code,
 int
 sdb_connection_ping(sdb_conn_t *conn);
 
+/*
+ * sdb_connection_server_version:
+ * Send back the backend server version to the connected client.
+ *
+ * Returns:
+ *  - 0 on success
+ *  - a negative value else
+ */
+int
+sdb_connection_server_version(sdb_conn_t *conn);
+
 /*
  * sdb_fe_parse:
  * 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.
+ * of parse trees (for each command). 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
@@ -141,17 +160,6 @@ sdb_connection_ping(sdb_conn_t *conn);
 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_exec(sdb_conn_t *conn, sdb_conn_node_t *node);
-
 /*
  * session handling
  */
@@ -172,10 +180,10 @@ sdb_fe_session_start(sdb_conn_t *conn);
  */
 
 /*
- * sdb_fe_query, sdb_fe_fetch, sdb_fe_list, sdb_fe_lookup:
+ * sdb_fe_query, sdb_fe_fetch, sdb_fe_list, sdb_fe_lookup, sdb_fe_store:
  * 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.
+ * SDB_CONNECTION_LOOKUP, and SDB_CONNECTION_STORE commands respectively. It
+ * is expected that the current command has been initialized already.
  *
  * Returns:
  *  - 0 on success
@@ -189,63 +197,26 @@ 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_store(sdb_conn_t *conn);
 
 /*
- * 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.
+ * sdb_fe_store_host, sdb_fe_store_service, sdb_fe_store_metric,
+ * sdb_fe_store_attribute:
+ * Execute the 'STORE' command for the respective object type.
  *
  * 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
- */
+sdb_fe_store_host(sdb_conn_t *conn, const sdb_proto_host_t *host);
 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
- */
+sdb_fe_store_service(sdb_conn_t *conn, const sdb_proto_service_t *svc);
+int
+sdb_fe_store_metric(sdb_conn_t *conn, const sdb_proto_metric_t *metric);
 int
-sdb_fe_exec_timeseries(sdb_conn_t *conn,
-               const char *hostname, const char *metric,
-               sdb_timeseries_opts_t *opts);
+sdb_fe_store_attribute(sdb_conn_t *conn, const sdb_proto_attribute_t *attr);
 
 #ifdef __cplusplus
 } /* extern "C" */