Let the network protocol and SysQL support last_update for metric stores.

[sysdb.git] / src / include / utils / proto.h

diff --git a/src/include/utils/proto.h b/src/include/utils/proto.h
index 4968977d7de4f9ecac7fbf5090fc46e46aa42984..a9ea1e321d4368fb61ae87fda233056e561b7cf2 100644 (file)
--- a/src/include/utils/proto.h
+++ b/src/include/utils/proto.h
@@ -37,6 +37,44 @@
 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;
+#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;
+       const char *hostname;
+       const char *name;
+       const char *store_type; /* optional */
+       const char *store_id;   /* optional */
+       sdb_time_t store_last_update; /* optional */
+} sdb_proto_metric_t;
+#define SDB_PROTO_METRIC_INIT { 0, NULL, NULL, NULL, NULL, 0 }
+
+typedef struct {
+       sdb_time_t last_update;
+       int parent_type;
+       const char *hostname; /* optional */
+       const char *parent;
+       const char *key;
+       sdb_data_t value;
+} sdb_proto_attribute_t;
+#define SDB_PROTO_ATTRIBUTE_INIT { 0, 0, NULL, NULL, NULL, SDB_DATA_INIT }
+
 /*
  * sdb_proto_marshal:
  * Encode the message into the wire format by adding an appropriate header.
@@ -54,6 +92,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.
@@ -66,26 +118,93 @@ sdb_proto_marshal(char *buf, size_t buf_len, uint32_t code,
  *  - a negative value else
  */
 ssize_t
-sdb_proto_marshal_data(char *buf, size_t buf_len, sdb_data_t *datum);
+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.
  *
  * Returns:
- *  - 0 on success
+ *  - the number of bytes read on success
  *  - a negative value else
  */
-int
+ssize_t
 sdb_proto_unmarshal_header(const char *buf, size_t buf_len,
                uint32_t *code, uint32_t *msg_len);
 
 /*
- * sdb_proto_unmarshal_int:
- * Read and decode an integer from the specified string.
+ * sdb_proto_unmarshal_int32:
+ * Read and decode a 32-bit integer from the specified string.
+ *
+ * Returns:
+ *  - the number of bytes read on success
+ *  - a negative value else
+ */
+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
  */
-uint32_t
-sdb_proto_unmarshal_int(const char *buf, size_t buf_len);
+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" */