frontend: Connection-specific functions now use the sdb_conn_ prefix.

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

diff --git a/src/include/frontend/connection.h b/src/include/frontend/connection.h
index 4791a5e4523c61f1d76d56f88c113d1c4ae26382..349993224ebfe336ad7033d312274ee60ff9b99c 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>
 
@@ -39,6 +40,10 @@
 extern "C" {
 #endif
 
+/*
+ * sdb_conn_t represents an open connection from a client. It inherits from
+ * sdb_object_t and may safely be cast to a generic object.
+ */
 typedef struct sdb_conn sdb_conn_t;
 
 /*
@@ -53,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
@@ -70,33 +81,36 @@ 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:
- * Close a open connection and deallocate any memory. The connection object is
- * no longer valid after calling this function.
+ * Close an open connection. Any subsequent reads from the connection will
+ * fail. Use sdb_object_deref to free the memory used by the object.
  */
 void
 sdb_connection_close(sdb_conn_t *conn);
 
 /*
- * sdb_connection_read:
- * Read from an open connection until reading would block.
+ * sdb_connection_handle:
+ * Read from an open connection until reading would block and handle all
+ * incoming commands.
  *
  * Returns:
  *  - the number of bytes read (0 on EOF)
  *  - a negative value on error
  */
 ssize_t
-sdb_connection_read(sdb_conn_t *conn);
+sdb_connection_handle(sdb_conn_t *conn);
 
 /*
  * sdb_connection_send:
@@ -122,36 +136,22 @@ int
 sdb_connection_ping(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.
- *
- * 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_fe_exec:
- * Execute the command identified by 'node' on the specified connection.
+ * sdb_connection_server_version:
+ * Send back the backend server version to the connected client.
  *
  * Returns:
  *  - 0 on success
  *  - a negative value else
  */
 int
-sdb_fe_exec(sdb_conn_t *conn, sdb_conn_node_t *node);
+sdb_connection_server_version(sdb_conn_t *conn);
 
 /*
  * session handling
  */
 
 /*
- * sdb_fe_session_start:
+ * sdb_conn_session_start:
  * Start a new user session on the specified connection.
  *
  * Returns:
@@ -159,44 +159,51 @@ sdb_fe_exec(sdb_conn_t *conn, sdb_conn_node_t *node);
  *  - a negative value else
  */
 int
-sdb_fe_session_start(sdb_conn_t *conn);
+sdb_conn_session_start(sdb_conn_t *conn);
 
 /*
  * store access
  */
 
 /*
- * sdb_fe_fetch:
- * Send the named host, serialized as JSON, to the client.
+ * sdb_conn_query, sdb_conn_fetch, sdb_conn_list, sdb_conn_lookup,
+ * sdb_conn_store:
+ * Handle the SDB_CONNECTION_QUERY, SDB_CONNECTION_FETCH, SDB_CONNECTION_LIST,
+ * SDB_CONNECTION_LOOKUP, and SDB_CONNECTION_STORE commands respectively. It
+ * is expected that the current command has been initialized already.
  *
  * Returns:
  *  - 0 on success
  *  - a negative value else
  */
 int
-sdb_fe_fetch(sdb_conn_t *conn, const char *name);
-
-/*
- * sdb_fe_list:
- * Send a complete listing of the store, serialized as JSON, to the client.
- *
- * Returns:
- *  - 0 on success
- *  - a negative value else
- */
+sdb_conn_query(sdb_conn_t *conn);
+int
+sdb_conn_fetch(sdb_conn_t *conn);
 int
-sdb_fe_list(sdb_conn_t *conn);
+sdb_conn_list(sdb_conn_t *conn);
+int
+sdb_conn_lookup(sdb_conn_t *conn);
+int
+sdb_conn_store(sdb_conn_t *conn);
 
 /*
- * sdb_fe_lookup:
- * Send a list of hosts matching 'm', serialized as JSON, to the client.
+ * sdb_conn_store_host, sdb_conn_store_service, sdb_conn_store_metric,
+ * sdb_conn_store_attribute:
+ * Execute the 'STORE' command for the respective object type.
  *
  * Returns:
  *  - 0 on success
  *  - a negative value else
  */
 int
-sdb_fe_lookup(sdb_conn_t *conn, sdb_store_matcher_t *m);
+sdb_conn_store_host(sdb_conn_t *conn, const sdb_proto_host_t *host);
+int
+sdb_conn_store_service(sdb_conn_t *conn, const sdb_proto_service_t *svc);
+int
+sdb_conn_store_metric(sdb_conn_t *conn, const sdb_proto_metric_t *metric);
+int
+sdb_conn_store_attribute(sdb_conn_t *conn, const sdb_proto_attribute_t *attr);
 
 #ifdef __cplusplus
 } /* extern "C" */