X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=src%2Finclude%2Ffrontend%2Fconnection.h;h=906f906acbea436c5518dd84e798145a84b4d5ac;hb=d81bfcccccea93ac261b75814e530a5fc50cfc58;hp=cbe4c2ab233481208e32c815c2923b064be1c3b6;hpb=c2b7616c8a80c5de6356b675d55a4ee36415fd7b;p=sysdb.git diff --git a/src/include/frontend/connection.h b/src/include/frontend/connection.h index cbe4c2a..906f906 100644 --- 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 @@ -36,24 +39,37 @@ 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, +/* + * 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; - /* 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: @@ -69,22 +85,23 @@ sdb_connection_accept(int fd); /* * 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: @@ -109,12 +126,38 @@ 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. 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_session_start: + * sdb_fe_session_start: * Start a new user session on the specified connection. * * Returns: @@ -122,22 +165,87 @@ 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. + * sdb_fe_query, sdb_fe_fetch, sdb_fe_list, sdb_fe_lookup: + * Handle the SDB_CONNECTION_QUERY, SDB_CONNECTION_FETCH, SDB_CONNECTION_LIST, + * and SDB_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" */