store.h: Updated some documentation comments.

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

diff --git a/src/include/core/store.h b/src/include/core/store.h
index aa53e8eadec81721c19d0c84adefe7634a146bb3..678af6ff9e706f85a33080ac5a377142e17b0e23 100644 (file)
--- a/src/include/core/store.h
+++ b/src/include/core/store.h
@@ -103,9 +103,9 @@ typedef struct sdb_store sdb_store_t;
 #define SDB_STORE(obj) ((sdb_store_t *)(obj))
 
 /*
 #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
- * object to access its name.
+ * sdb_store_obj_t represents the super-class of any stored object. It
+ * inherits from sdb_object_t and may safely be cast to a generic object to
+ * access its name.

  */
 struct sdb_store_obj;
 typedef struct sdb_store_obj sdb_store_obj_t;
  */
 struct sdb_store_obj;
 typedef struct sdb_store_obj sdb_store_obj_t;


@@ -130,8 +130,7 @@ typedef struct sdb_store_expr sdb_store_expr_t;
 #define SDB_STORE_EXPR(obj) ((sdb_store_expr_t *)(obj))
 
 /*
 #define SDB_STORE_EXPR(obj) ((sdb_store_expr_t *)(obj))
 
 /*

- * An expression iterator iterates over the values of an iterable expression
- * (see sdb_store_expr_iterable).
+ * An expression iterator iterates over the values of an iterable expression.

  */
 struct sdb_store_expr_iter;
 typedef struct sdb_store_expr_iter sdb_store_expr_iter_t;
  */
 struct sdb_store_expr_iter;
 typedef struct sdb_store_expr_iter sdb_store_expr_iter_t;


@@ -284,29 +283,11 @@ extern sdb_store_reader_t sdb_store_reader;
 sdb_store_t *
 sdb_store_create(void);
 
 sdb_store_t *
 sdb_store_create(void);
 

-/*
- * sdb_store_init:
- * Initialize the store sub-system. This function has to be called before
- * doing any other store operations.
- *
- * Returns:
- *  - 0 on success
- *  - a negative value else
- */
-int
-sdb_store_init(void);
-
-/*
- * sdb_store_clear:
- * Clear the entire store and remove all stored objects.
- */
-void
-sdb_store_clear(void);
-

 /*
  * sdb_store_host, sdb_store_service, sdb_store_metric, sdb_store_attribute,
  * sdb_store_metric_attr:
 /*
  * sdb_store_host, sdb_store_service, sdb_store_metric, sdb_store_attribute,
  * sdb_store_metric_attr:

- * Store an object in the specified store.
+ * Store an object in the specified store. The hostname is expected to be
+ * canonical.

  */
 int
 sdb_store_host(sdb_store_t *store, const char *name, sdb_time_t last_update);
  */
 int
 sdb_store_host(sdb_store_t *store, const char *name, sdb_time_t last_update);


@@ -530,20 +511,10 @@ int
 sdb_store_expr_eval(sdb_store_expr_t *expr, sdb_store_obj_t *obj,
                sdb_data_t *res, sdb_store_matcher_t *filter);
 
 sdb_store_expr_eval(sdb_store_expr_t *expr, sdb_store_obj_t *obj,
                sdb_data_t *res, sdb_store_matcher_t *filter);
 

-/*
- * sdb_store_expr_iterable:
- * Check whether an expression, evaluated in the specified context (HOST,
- * SERVICE, METRIC) is iterable, that is, if it may evaluate to multiple
- * values.
- */
-bool
-sdb_store_expr_iterable(sdb_store_expr_t *expr, int context);
-

 /*
  * sdb_store_expr_iter:
  * Iterate over the elements of an iterable expression. sdb_store_expr_iter
  * returns NULL if the expression is not iterable (for the specified object).
 /*
  * sdb_store_expr_iter:
  * Iterate over the elements of an iterable expression. sdb_store_expr_iter
  * returns NULL if the expression is not iterable (for the specified object).

- * See also sdb_store_expr_iterable.

  *
  * sdb_store_expr_iter_get_next returns NULL if there is no next element.
  */
  *
  * sdb_store_expr_iter_get_next returns NULL if there is no next element.
  */


@@ -701,9 +672,9 @@ typedef int (*sdb_store_lookup_cb)(sdb_store_obj_t *obj,
  * sdb_store_scan:
  * Look up objects of the specified type in the specified store. The specified
  * callback function is called for each object in the store matching 'm'. The
  * sdb_store_scan:
  * Look up objects of the specified type in the specified store. The specified
  * callback function is called for each object in the store matching 'm'. The

- * function performs a full scan of all objects stored in the database. If
- * specified, the filter will be used to preselect objects for further
- * evaluation. See the description of 'sdb_store_matcher_matches' for details.
+ * function performs a full scan of all stored objects. If specified, the
+ * filter will be used to preselect objects for further evaluation. See the
+ * description of 'sdb_store_matcher_matches' for details.

  *
  * Returns:
  *  - 0 on success
  *
  * Returns:
  *  - 0 on success