connection: Let sdb_connection_close not deallocate the connection.

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

diff --git a/src/include/frontend/connection.h b/src/include/frontend/connection.h
index a890bd0ffae75d16fa1e39909c12fb5c0621d86b..906f906acbea436c5518dd84e798145a84b4d5ac 100644 (file)
--- a/src/include/frontend/connection.h
+++ b/src/include/frontend/connection.h
@@ -39,6 +39,10 @@
 extern "C" {
 #endif
 
+/*
+ * 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;
 
 /*
@@ -81,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:
@@ -126,14 +131,15 @@ sdb_connection_ping(sdb_conn_t *conn);
  * 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.
+ * (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_fe_parse(const char *query, int len, sdb_strbuf_t *errbuf);
 
 /*
  * sdb_fe_exec:
@@ -167,9 +173,9 @@ sdb_fe_session_start(sdb_conn_t *conn);
 
 /*
  * 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.
+ * 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
@@ -188,22 +194,22 @@ 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. See sdb_store_tojson for details.
+ * 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 *name,
-               sdb_store_matcher_t *filter);
+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. See sdb_store_tojson for details.
+ * be included.
  *
  * Returns:
  *  - 0 on success
@@ -216,7 +222,7 @@ 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. See sdb_store_tojson for details.
+ * matching the filter will be included.
  *
  * Returns:
  *  - 0 on success