frontend parser: Added 'len' parameter to sdb_fe_parse().

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

diff --git a/src/include/frontend/connection.h b/src/include/frontend/connection.h
index 141248f211a97ffff1b89bc0cb07024092d3cc23..45d377e10df2ffb9ff28220b9c331f0410e47e0a 100644 (file)
--- a/src/include/frontend/connection.h
+++ b/src/include/frontend/connection.h
@@ -28,6 +28,8 @@
 #ifndef SDB_FRONTEND_CONNECTION_H
 #define SDB_FRONTEND_CONNECTION_H 1
 
+#include "frontend/proto.h"
+#include "utils/llist.h"
 #include "utils/strbuf.h"
 
 #include <inttypes.h>
@@ -36,21 +38,20 @@
 extern "C" {
 #endif
 
-/* status codes returned to a client */
-typedef enum {
-       CONNECTION_OK = 0,
-       CONNECTION_ERROR
-} sdb_conn_status_t;
-
-/* accepted commands / state of the connection */
-typedef enum {
-       CONNECTION_IDLE = 0,
-       CONNECTION_PING,
-       CONNECTION_STARTUP,
-} sdb_conn_state_t;
-
 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_accpet:
  * Accept a new connection on the specified file-descriptor 'fd' and return a
@@ -92,7 +93,7 @@ sdb_connection_read(sdb_conn_t *conn);
  */
 ssize_t
 sdb_connection_send(sdb_conn_t *conn, uint32_t code,
-               uint32_t msg_len, char *msg);
+               uint32_t msg_len, const char *msg);
 
 /*
  * sdb_connection_ping:
@@ -105,12 +106,37 @@ sdb_connection_send(sdb_conn_t *conn, uint32_t code,
 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.
+ *
+ * Returns:
+ *  - 0 on success
+ *  - a negative value else
+ */
+int
+sdb_fe_exec(sdb_conn_t *conn, sdb_conn_node_t *node);
+
 /*
  * session handling
  */
 
 /*
- * sdb_session_start:
+ * sdb_fe_session_start:
  * Start a new user session on the specified connection.
  *
  * Returns:
@@ -118,7 +144,22 @@ sdb_connection_ping(sdb_conn_t *conn);
  *  - a negative value else
  */
 int
-sdb_session_start(sdb_conn_t *conn);
+sdb_fe_session_start(sdb_conn_t *conn);
+
+/*
+ * store access
+ */
+
+/*
+ * sdb_fe_list:
+ * Send a complete listing of the store, serialized as JSON, to the client.
+ *
+ * Returns:
+ *  - 0 on success
+ *  - a negative value else
+ */
+int
+sdb_fe_list(sdb_conn_t *conn);
 
 #ifdef __cplusplus
 } /* extern "C" */