![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
index 5748211f4c1d5c78f367eb1fc9672c825f757c2c..b329fa1ec9d8b3c003207b0c197085aeed6c29d6 100644 (file)
#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>
extern "C" {
#endif
-/* a generic connection object */
-typedef struct {
- /* file-descriptor of the open connection */
- int fd;
-
- /* read buffer */
- sdb_strbuf_t *buf;
+typedef struct sdb_conn sdb_conn_t;
- /* connection / protocol state information */
- uint32_t cmd;
- uint32_t cmd_len;
-} 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_init:
- * Initialize an (already allocated) connection. This function allocates and
- * initialized any attributes. It's an error to call init on an already
- * initialized object.
+ * 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_init(sdb_conn_t *conn);
+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.
+ *
+ * Returns:
+ * - 0 on success
+ * - a negative value else
+ */
+sdb_conn_t *
+sdb_connection_accept(int fd);
/*
* sdb_connection_close:
- * Close a open connection and deallocate any memory used by its attributes.
+ * Close a open connection and deallocate any memory. The connection object is
+ * no longer valid after calling this function.
*/
void
sdb_connection_close(sdb_conn_t *conn);
ssize_t
sdb_connection_read(sdb_conn_t *conn);
+/*
+ * sdb_connection_send:
+ * Send to an open connection.
+ *
+ * Returns:
+ * - the number of bytes written
+ * - a negative value on error
+ */
+ssize_t
+sdb_connection_send(sdb_conn_t *conn, uint32_t code,
+ uint32_t msg_len, const char *msg);
+
+/*
+ * sdb_connection_ping:
+ * Send back a backend status indicator to the connected client.
+ *
+ * Returns:
+ * - 0 on success
+ * - a negative value else
+ */
+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. If specified, errbuf will be used to record parse
+ * errors.
+ *
+ * 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_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
+ */
+
+/*
+ * sdb_fe_session_start:
+ * Start a new user session on the specified connection.
+ *
+ * Returns:
+ * - 0 on success
+ * - a negative value else
+ */
+int
+sdb_fe_session_start(sdb_conn_t *conn);
+
+/*
+ * store access
+ */
+
+/*
+ * sdb_fe_query, sdb_fe_fetch, sdb_fe_list, sdb_fe_lookup:
+ * Handle the CONNECTION_QUERY, CONNECTION_FETCH, CONNECTION_LIST, and
+ * CONNECTION_LOOKUP commands respectively. It is expected that the current
+ * command has been initialized already.
+ *
+ * Returns:
+ * - 0 on success
+ * - a negative value else
+ */
+int
+sdb_fe_query(sdb_conn_t *conn);
+int
+sdb_fe_fetch(sdb_conn_t *conn);
+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_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.
+ *
+ * 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
+ */
+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
+ */
+int
+sdb_fe_exec_timeseries(sdb_conn_t *conn,
+ const char *hostname, const char *metric,
+ sdb_timeseries_opts_t *opts);
+
#ifdef __cplusplus
} /* extern "C" */
#endif