X-Git-Url: https://git.tokkee.org/?p=sysdb.git;a=blobdiff_plain;f=src%2Finclude%2Ffrontend%2Fconnection.h;h=04e7d8df2ca6b9f0003de8a07499caf8e3a793bd;hp=5748211f4c1d5c78f367eb1fc9672c825f757c2c;hb=816e3e1e9fea25d37504e3f0f51b758a41e60ae3;hpb=2a0f3c8f7d913518afd60156c7d324340d8f6478 diff --git a/src/include/frontend/connection.h b/src/include/frontend/connection.h index 5748211..04e7d8d 100644 --- a/src/include/frontend/connection.h +++ b/src/include/frontend/connection.h @@ -28,7 +28,11 @@ #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 "utils/proto.h" #include @@ -36,49 +40,183 @@ extern "C" { #endif -/* a generic connection object */ -typedef struct { - /* file-descriptor of the open connection */ - int fd; +/* + * 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; - /* read buffer */ - sdb_strbuf_t *buf; +/* + * 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)) - /* connection / protocol state information */ - uint32_t cmd; - uint32_t cmd_len; -} sdb_conn_t; +/* + * 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_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. 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_conn_setup_cb setup, void *user_data); /* * sdb_connection_close: - * Close a open connection and deallocate any memory used by its attributes. + * 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: + * 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_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); + +/* + * sdb_fe_parse: + * Parse the query text specified in 'query' of length 'len' and return a list + * of parse trees (for each command). 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); + +/* + * 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, sdb_fe_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_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); +int +sdb_fe_store(sdb_conn_t *conn); + +/* + * sdb_fe_store_host, sdb_fe_store_service, sdb_fe_store_metric, + * sdb_fe_store_attribute: + * Execute the 'STORE' command for the respective object type. + * + * Returns: + * - 0 on success + * - a negative value else + */ +int +sdb_fe_store_host(sdb_conn_t *conn, const sdb_proto_host_t *host); +int +sdb_fe_store_service(sdb_conn_t *conn, const sdb_proto_service_t *svc); +int +sdb_fe_store_metric(sdb_conn_t *conn, const sdb_proto_metric_t *metric); +int +sdb_fe_store_attribute(sdb_conn_t *conn, const sdb_proto_attribute_t *attr); #ifdef __cplusplus } /* extern "C" */