Code

proto: Make sdb_proto_marshal_int32 a public function.
[sysdb.git] / src / include / utils / proto.h
index a872dd51b309c6a05a659d9ea4e70a70933fdf35..56715630524594a71e524932def3f1a01a9f7670 100644 (file)
@@ -46,12 +46,14 @@ typedef struct {
        sdb_time_t last_update;
        const char *name;
 } sdb_proto_host_t;
+#define SDB_PROTO_HOST_INIT { 0, NULL }
 
 typedef struct {
        sdb_time_t last_update;
        const char *hostname;
        const char *name;
 } sdb_proto_service_t;
+#define SDB_PROTO_SERVICE_INIT { 0, NULL, NULL }
 
 typedef struct {
        sdb_time_t last_update;
@@ -60,6 +62,7 @@ typedef struct {
        const char *store_type; /* optional */
        const char *store_id;   /* optional */
 } sdb_proto_metric_t;
+#define SDB_PROTO_METRIC_INIT { 0, NULL, NULL, NULL, NULL }
 
 typedef struct {
        sdb_time_t last_update;
@@ -67,8 +70,9 @@ typedef struct {
        const char *hostname; /* optional */
        const char *parent;
        const char *key;
-       const sdb_data_t *value;
+       sdb_data_t value;
 } sdb_proto_attribute_t;
+#define SDB_PROTO_ATTRIBUTE_INIT { 0, 0, NULL, NULL, NULL, SDB_DATA_INIT }
 
 /*
  * sdb_proto_marshal:
@@ -87,6 +91,20 @@ ssize_t
 sdb_proto_marshal(char *buf, size_t buf_len, uint32_t code,
                uint32_t msg_len, const char *msg);
 
+/*
+ * sdb_proto_marshal_int32:
+ * Encode the 32-bit integer into the wire format and write it to buf.
+ *
+ * Returns:
+ *  - The number of bytes of the encoded value 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_int32(char *buf, size_t buf_len, uint32_t v);
+
 /*
  * sdb_proto_marshal_data:
  * Encode a datum into the wire format and write it to buf.
@@ -151,6 +169,42 @@ sdb_proto_unmarshal_header(const char *buf, size_t buf_len,
 ssize_t
 sdb_proto_unmarshal_int32(const char *buf, size_t buf_len, uint32_t *v);
 
+/*
+ * sdb_proto_unmarshal_data:
+ * Read and decode a datum from the specified string. The datum's data will be
+ * allocated dynamically if necessary and will have to be free'd using
+ * sdb_data_free_datum.
+ *
+ * Returns:
+ *  - the number of bytes read on success
+ *  - a negative value else
+ */
+ssize_t
+sdb_proto_unmarshal_data(const char *buf, size_t len, sdb_data_t *datum);
+
+/*
+ * sdb_proto_unmarshal_host, sdb_proto_unmarshal_service,
+ * sdb_proto_unmarshal_metric, sdb_proto_unmarshal_attribute:
+ * Read and decode a host, service, metric, or attribute object from the
+ * specified string.
+ *
+ * Returns:
+ *  - the number of bytes read on success
+ *  - a negative value else
+ */
+ssize_t
+sdb_proto_unmarshal_host(const char *buf, size_t len,
+               sdb_proto_host_t *host);
+ssize_t
+sdb_proto_unmarshal_service(const char *buf, size_t len,
+               sdb_proto_service_t *svc);
+ssize_t
+sdb_proto_unmarshal_metric(const char *buf, size_t len,
+               sdb_proto_metric_t *metric);
+ssize_t
+sdb_proto_unmarshal_attribute(const char *buf, size_t len,
+               sdb_proto_attribute_t *attr);
+
 #ifdef __cplusplus
 } /* extern "C" */
 #endif