X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=src%2Finclude%2Futils%2Fproto.h;h=fd842c1b0caf8c6f48b64b03a7c7d1c2db9f5488;hb=4b1c3e70c727641934d697339cad02cda0a3c565;hp=6f0907feee2c2e5243e61e2c37ce47419a7539b2;hpb=90064393a1c5c27ef0ae05652e6672814772fdce;p=sysdb.git

diff --git a/src/include/utils/proto.h b/src/include/utils/proto.h
index 6f0907f..fd842c1 100644
--- a/src/include/utils/proto.h
+++ b/src/include/utils/proto.h
@@ -28,7 +28,7 @@
 #ifndef SDB_UTILS_PROTO_H
 #define SDB_UTILS_PROTO_H 1
 
-#include "utils/strbuf.h"
+#include "core/data.h"
 
 #include <stdint.h>
 #include <unistd.h>
@@ -37,6 +37,39 @@
 extern "C" {
 #endif
 
+/*
+ * sdb_proto_host, sdb_proto_service, sdb_proto_metric:
+ * Protocol-specific representations of the basic information of stored
+ * objects.
+ */
+typedef struct {
+	sdb_time_t last_update;
+	const char *name;
+} sdb_proto_host_t;
+
+typedef struct {
+	sdb_time_t last_update;
+	const char *hostname;
+	const char *name;
+} sdb_proto_service_t;
+
+typedef struct {
+	sdb_time_t last_update;
+	const char *hostname;
+	const char *name;
+	const char *store_type; /* optional */
+	const char *store_id;   /* optional */
+} sdb_proto_metric_t;
+
+typedef struct {
+	sdb_time_t last_update;
+	int parent_type;
+	const char *hostname; /* optional */
+	const char *parent;
+	const char *key;
+	const sdb_data_t *value;
+} sdb_proto_attribute_t;
+
 /*
  * sdb_proto_marshal:
  * Encode the message into the wire format by adding an appropriate header.
@@ -44,28 +77,75 @@ extern "C" {
  * the header (64 bits) and the entire message.
  *
  * Returns:
- *  - the number of bytes of the full encoded message on success (even if less
- *    than that fit into and was written to the buffer)
+ *  - The number of bytes of the full encoded message on success. The function
+ *    does not write more than 'buf_len' bytes. If the output was truncated
+ *    then the return value is the number of bytes which would have been
+ *    written if enough space had been available.
  *  - a negative value on error
  */
 ssize_t
 sdb_proto_marshal(char *buf, size_t buf_len, uint32_t code,
 		uint32_t msg_len, const char *msg);
 
+/*
+ * sdb_proto_marshal_data:
+ * Encode a datum into the wire format and write it to buf.
+ *
+ * Returns:
+ *  - The number of bytes of the full encoded datum on success. The function
+ *    does not write more than 'buf_len' bytes. If the output was truncated
+ *    then the return value is the number of bytes which would have been
+ *    written if enough space had been available.
+ *  - a negative value else
+ */
+ssize_t
+sdb_proto_marshal_data(char *buf, size_t buf_len, const sdb_data_t *datum);
+
+/*
+ * sdb_proto_marshal_host, sdb_proto_marshal_service,
+ * sdb_proto_marshal_metric, sdb_proto_marshal_attribute:
+ * Encode the basic information of a stored object into the wire format and
+ * write it to buf. These functions are similar to the sdb_store_<type>
+ * functions. See their documentation for details about the arguments.
+ *
+ * Returns:
+ *  - The number of bytes of the full encoded datum on success. The function
+ *    does not write more than 'buf_len' bytes. If the output was truncated
+ *    then the return value is the number of bytes which would have been
+ *    written if enough space had been available.
+ *  - a negative value else
+ */
+ssize_t
+sdb_proto_marshal_host(char *buf, size_t buf_len,
+		const sdb_proto_host_t *host);
+ssize_t
+sdb_proto_marshal_service(char *buf, size_t buf_len,
+		const sdb_proto_service_t *svc);
+ssize_t
+sdb_proto_marshal_metric(char *buf, size_t buf_len,
+		const sdb_proto_metric_t *metric);
+ssize_t
+sdb_proto_marshal_attribute(char *buf, size_t buf_len,
+		const sdb_proto_attribute_t *attr);
+
 /*
  * sdb_proto_unmarshal_header:
- * Read and decode a message header from the specified string buffer.
+ * Read and decode a message header from the specified string.
  *
  * Returns:
  *  - 0 on success
  *  - a negative value else
  */
 int
-sdb_proto_unmarshal_header(sdb_strbuf_t *buf,
+sdb_proto_unmarshal_header(const char *buf, size_t buf_len,
 		uint32_t *code, uint32_t *msg_len);
 
+/*
+ * sdb_proto_unmarshal_int32:
+ * Read and decode a 32-bit integer from the specified string.
+ */
 uint32_t
-sdb_proto_get_int(sdb_strbuf_t *buf, size_t offset);
+sdb_proto_unmarshal_int32(const char *buf, size_t buf_len);
 
 #ifdef __cplusplus
 } /* extern "C" */