Code

frontend: Let LIST not include details.
[sysdb.git] / src / include / core / store.h
index a327ae9d31ebd31744e4ce6d9d0786b0d183ae29..1dfa9ab51005f3b116ce18332b9f6124c95cd833 100644 (file)
@@ -139,6 +139,7 @@ sdb_store_service(const char *hostname, const char *name,
  */
 struct sdb_store_matcher;
 typedef struct sdb_store_matcher sdb_store_matcher_t;
+#define SDB_STORE_MATCHER(obj) ((sdb_store_matcher_t *)(obj))
 
 /*
  * sdb_store_attr_matcher:
@@ -168,17 +169,51 @@ sdb_store_host_matcher(const char *host_name, const char *host_name_re,
                sdb_store_matcher_t *service_matcher,
                sdb_store_matcher_t *attr_matcher);
 
+/*
+ * sdb_store_dis_matcher:
+ * Creates a matcher matching the disjunction (logical OR) of two matchers.
+ */
+sdb_store_matcher_t *
+sdb_store_dis_matcher(sdb_store_matcher_t *left, sdb_store_matcher_t *right);
+
+/*
+ * sdb_store_con_matcher:
+ * Creates a matcher matching the conjunction (logical AND) of two matchers.
+ */
+sdb_store_matcher_t *
+sdb_store_con_matcher(sdb_store_matcher_t *left, sdb_store_matcher_t *right);
+
 /*
  * sdb_store_matcher_matches:
  * Check whether the specified matcher matches the specified store object.
  *
  * Returns:
- *  - 0 if the object matches
- *  - a negative value else
+ *  - 1 if the object matches
+ *  - 0 else
  */
 int
 sdb_store_matcher_matches(sdb_store_matcher_t *m, sdb_store_base_t *obj);
 
+/*
+ * sdb_store_lookup_cb:
+ * Lookup callback. It is called for each matching object when looking up data
+ * in the store. The lookup aborts if the callback returns non-zero.
+ */
+typedef int (*sdb_store_lookup_cb)(sdb_store_base_t *obj, void *user_data);
+
+/*
+ * sdb_store_lookup:
+ * Look up objects in the store. The specified callback function is called for
+ * each object in the store matching 'm'.
+ *
+ * Returns:
+ *  - 0 on success
+ *  - a negative value else
+ */
+int
+sdb_store_lookup(sdb_store_matcher_t *m, sdb_store_lookup_cb cb,
+               void *user_data);
+
 /*
  * Flags for serialization functions.
  *
@@ -189,6 +224,8 @@ enum {
        SDB_SKIP_ATTRIBUTES         = 1 << 0,
        SDB_SKIP_SERVICES           = 1 << 1,
        SDB_SKIP_SERVICE_ATTRIBUTES = 1 << 2,
+
+       SDB_SKIP_ALL                = 0xffff,
 };
 
 /*
@@ -215,6 +252,24 @@ sdb_store_tojson(sdb_strbuf_t *buf, int flags);
 int
 sdb_store_host_tojson(sdb_store_base_t *host, sdb_strbuf_t *buf, int flags);
 
+/*
+ * sdb_store_iter_cb:
+ * Store iterator callback. Iteration stops if the callback returns non-zero.
+ */
+typedef int (*sdb_store_iter_cb)(sdb_store_base_t *obj, void *user_data);
+
+/*
+ * sdb_store_iterate:
+ * Iterate the entire store, calling the specified callback for each object.
+ * The user_data pointer is passed on to each call of the callback.
+ *
+ * Returns:
+ *  - 0 on success
+ *  - a negative value else
+ */
+int
+sdb_store_iterate(sdb_store_iter_cb cb, void *user_data);
+
 #ifdef __cplusplus
 } /* extern "C" */
 #endif