Code

core: Export the sdb_store, sdb_store_reader, sdb_store_writer types.
[sysdb.git] / src / include / core / store.h
index e851dd9f955ee38cb3bec993fe753aa3e4f5a537..e5e011875e1775a1592c0511e06d5f3928121b50 100644 (file)
@@ -94,6 +94,14 @@ enum {
                : ((f) == SDB_FIELD_TIMESERIES) ? SDB_TYPE_BOOLEAN \
                : -1)
 
+/*
+ * sdb_store_t represents an in-memory store. It inherits from sdb_object_t
+ * and may safely be case to a generic object.
+ */
+struct sdb_store;
+typedef struct sdb_store sdb_store_t;
+#define SDB_STORE(obj) ((sdb_store_t *)(obj))
+
 /*
  * sdb_store_obj_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
@@ -229,6 +237,13 @@ typedef struct {
                        sdb_object_t *user_data);
 } sdb_store_writer_t;
 
+/*
+ * sdb_store_writer:
+ * A store writer implementation that provides an in-memory object store. It
+ * expects a store object as its user-data argument.
+ */
+extern sdb_store_writer_t sdb_store_writer;
+
 /*
  * A store reader describes the interface to query a store implementation.
  */
@@ -255,6 +270,20 @@ typedef struct {
                        sdb_object_t *user_data);
 } sdb_store_reader_t;
 
+/*
+ * sdb_store_reader:
+ * A store reader implementation that uses an in-memory object store. It
+ * expects a store object as its user-data argument.
+ */
+extern sdb_store_reader_t sdb_store_reader;
+
+/*
+ * sdb_store_create:
+ * Allocate a new in-memory store.
+ */
+sdb_store_t *
+sdb_store_create(void);
+
 /*
  * sdb_store_init:
  * Initialize the store sub-system. This function has to be called before