frontend: Let FETCH/LIST/LOOKUP implementations accept filters.

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

diff --git a/src/include/frontend/connection.h b/src/include/frontend/connection.h
index cbe4c2ab233481208e32c815c2923b064be1c3b6..30e6509b553e73b910c9d3b120d5b0c98bef42e6 100644 (file)
--- a/src/include/frontend/connection.h
+++ b/src/include/frontend/connection.h
@@ -28,6 +28,9 @@
 #ifndef SDB_FRONTEND_CONNECTION_H
 #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>
@@ -36,24 +39,33 @@
 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 handling */
-       CONNECTION_IDLE = 0,
-       CONNECTION_PING,
-       CONNECTION_STARTUP,
+typedef struct sdb_conn sdb_conn_t;
 
-       /* querying */
-       CONNECTION_LIST,
-} sdb_conn_state_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))
 
-typedef struct sdb_conn sdb_conn_t;
+/*
+ * 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:
@@ -109,12 +121,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:
@@ -122,22 +159,51 @@ 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_fetch:
+ * Send the named host, serialized as JSON, to the client. If specified, only
+ * objects matching the filter will be included. See sdb_store_tojson for
+ * details.
+ *
+ * Returns:
+ *  - 0 on success
+ *  - a negative value else
+ */
+int
+sdb_fe_fetch(sdb_conn_t *conn, const char *name, sdb_store_matcher_t *filter);
+
 /*
  * sdb_fe_list:
- * Send a complete listing of the store, serialized as JSON, to the client.
+ * Send a complete listing of the store, serialized as JSON, to the client. If
+ * specified, only objects matching the filter will be included. See
+ * sdb_store_tojson for details.
+ *
+ * Returns:
+ *  - 0 on success
+ *  - a negative value else
+ */
+int
+sdb_fe_list(sdb_conn_t *conn, sdb_store_matcher_t *filter);
+
+/*
+ * sdb_fe_lookup:
+ * Send a list of hosts matching 'm', serialized as JSON, to the client. If
+ * specified, only objects matching the filter will be included. See
+ * sdb_store_tojson for details.
  *
  * Returns:
  *  - 0 on success
  *  - a negative value else
  */
 int
-sdb_fe_list(sdb_conn_t *conn);
+sdb_fe_lookup(sdb_conn_t *conn, sdb_store_matcher_t *m,
+               sdb_store_matcher_t *filter);
 
 #ifdef __cplusplus
 } /* extern "C" */