store: Added flags to JSON functions indicating information to leave out.

[sysdb.git] / src / include / core / store.h

diff --git a/src/include/core/store.h b/src/include/core/store.h
index bc4de1090f6d4a95e980835cf7c4033002776e79..cf4ecbbb6f1155444a451bf57535bf536704098e 100644 (file)
--- a/src/include/core/store.h
+++ b/src/include/core/store.h
@@ -40,6 +40,14 @@
 extern "C" {
 #endif
 
+/*
+ * sdb_store_base_t represents the super-class of any object stored in the
+ * database. It inherits from sdb_object_t and may safely be cast to a generic
+ * object to access its name.
+ */
+struct sdb_store_base;
+typedef struct sdb_store_base sdb_store_base_t;
+
 /*
  * sdb_store_host:
  * Add/update a host in the store. If the host, identified by its
@@ -99,6 +107,18 @@ int
 sdb_store_service(const char *hostname, const char *name,
                sdb_time_t last_update);
 
+/*
+ * Flags for serialization functions.
+ *
+ * By default, the full object will be included in the serialized output. When
+ * specifying any of the flags, the respective information will be left out.
+ */
+enum {
+       SDB_SKIP_ATTRIBUTES         = 1 << 0,
+       SDB_SKIP_SERVICES           = 1 << 1,
+       SDB_SKIP_SERVICE_ATTRIBUTES = 1 << 2,
+};
+
 /*
  * sdb_store_tojson:
  * Serialize the entire store to JSON and append the result to the specified
@@ -109,7 +129,19 @@ sdb_store_service(const char *hostname, const char *name,
  *  - a negative value on error
  */
 int
-sdb_store_tojson(sdb_strbuf_t *buf);
+sdb_store_tojson(sdb_strbuf_t *buf, int flags);
+
+/*
+ * sdb_store_host_tojson:
+ * Serialize a host object to JSON and append the result to the specified
+ * buffer.
+ *
+ * Returns:
+ *  - 0 on success
+ *  - a negative value on error
+ */
+int
+sdb_store_host_tojson(sdb_store_base_t *host, sdb_strbuf_t *buf, int flags);
 
 #ifdef __cplusplus
 } /* extern "C" */