X-Git-Url: https://git.tokkee.org/?p=sysdb.git;a=blobdiff_plain;f=src%2Finclude%2Ffrontend%2Fconnection.h;h=349993224ebfe336ad7033d312274ee60ff9b99c;hp=a2163bce9841d479557ad5f8c4f93bdf69ba4af5;hb=ef3a4a955deddc45d5f381ce20653cac3ca51656;hpb=88f23d9f98658358391add99a78db534bec4bb8b

diff --git a/src/include/frontend/connection.h b/src/include/frontend/connection.h
index a2163bc..3499932 100644
--- a/src/include/frontend/connection.h
+++ b/src/include/frontend/connection.h
@@ -29,7 +29,10 @@
 #define SDB_FRONTEND_CONNECTION_H 1
 
 #include "frontend/proto.h"
+#include "core/store.h"
+#include "utils/llist.h"
 #include "utils/strbuf.h"
+#include "utils/proto.h"
 
 #include <inttypes.h>
 
@@ -37,38 +40,77 @@
 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;
 
+/*
+ * 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_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
+ * 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
- * 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:
@@ -93,12 +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);
+
 /*
  * session handling
  */
 
 /*
- * sdb_fe_session_start:
+ * sdb_conn_session_start:
  * Start a new user session on the specified connection.
  *
  * Returns:
@@ -106,22 +159,51 @@ sdb_connection_ping(sdb_conn_t *conn);
  *  - 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_list:
- * Send a complete listing of the store, 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_list(sdb_conn_t *conn);
+sdb_conn_query(sdb_conn_t *conn);
+int
+sdb_conn_fetch(sdb_conn_t *conn);
+int
+sdb_conn_list(sdb_conn_t *conn);
+int
+sdb_conn_lookup(sdb_conn_t *conn);
+int
+sdb_conn_store(sdb_conn_t *conn);
+
+/*
+ * 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_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" */