Code

utils llist: Added sdb_llist_remove().
[sysdb.git] / src / include / utils / llist.h
index bd44d44c5053870b726b575ee7452a909e03d149..af8285f6a3367fdc026f81bf0387243ff143c20f 100644 (file)
@@ -121,9 +121,9 @@ sdb_llist_insert_sorted(sdb_llist_t *list,
 
 /*
  * sdb_llist_search:
- * Search for a 'key' in the given 'list'. The function will return the first
- * entry that matches the specified 'key'. For that purpose, the 'compare'
- * function is used. It should return 0 iff the two arguments compare equal.
+ * Search for a object in the given 'list'. The function will return the first
+ * entry for which the 'lookup' callback returns 0. The 'user_data' is passed
+ * on to the lookup function on each invocation.
  *
  * Returns:
  *  - a pointer to the first matching object
@@ -146,6 +146,20 @@ sdb_llist_search(sdb_llist_t *list,
 sdb_object_t *
 sdb_llist_search_by_name(sdb_llist_t *list, const char *key);
 
+/*
+ * sdb_llist_remove:
+ * Removes and returns the first matchin element of the list. The ref-count of
+ * the item will not be changed, that is, if the element will not be used any
+ * further, it should be de-referenced by the caller.
+ *
+ * Returns:
+ *  - a pointer to the first matching object
+ *  - NULL else
+ */
+sdb_object_t *
+sdb_llist_remove(sdb_llist_t *list,
+               sdb_llist_lookup_cb lookup, void *user_data);
+
 /*
  * sdb_llist_shift:
  * Removes and returns the first element of the list. The ref-count of the