Fix: add missing void param to bt_clock_class_priority_map_create

[babeltrace.git] / include / babeltrace / graph / clock-class-priority-map.h

diff --git a/include/babeltrace/graph/clock-class-priority-map.h b/include/babeltrace/graph/clock-class-priority-map.h
index 18c27308086e05f09bf7a2486b28e20a9671dfe1..d03b1ea9fdfc450fedad24430f6f4cb702053c65 100644 (file)
--- a/include/babeltrace/graph/clock-class-priority-map.h
+++ b/include/babeltrace/graph/clock-class-priority-map.h
@@ -56,6 +56,16 @@ A priority is a 64-bit unsigned integer. A lower value has a
 \em higher priority. Multiple clock classes can have the same priority
 within a given clock class priority map.
 
+The following functions can \em freeze clock class priority map objects:
+
+- bt_notification_event_create() freezes its clock class priority
+  map parameter.
+- bt_notification_inactivity_create() freezes its clock class priority
+  map parameter.
+
+You cannot modify a frozen clock class priority map object: it is
+considered immutable, except for \link refs reference counting\endlink.
+
 As with any Babeltrace object, clock class priority map objects have
 <a href="https://en.wikipedia.org/wiki/Reference_counting">reference
 counts</a>. See \ref refs to learn more about the reference counting
@@ -83,7 +93,7 @@ struct bt_clock_class_priority_map;
 
 @postsuccessrefcountret1
 */
-extern struct bt_clock_class_priority_map *bt_clock_class_priority_map_create();
+extern struct bt_clock_class_priority_map *bt_clock_class_priority_map_create(void);
 
 /**
 @brief Returns the number of CTF IR clock classes contained in the
@@ -99,7 +109,7 @@ extern struct bt_clock_class_priority_map *bt_clock_class_priority_map_create();
 @prenotnull{clock_class_priority_map}
 @postrefcountsame{clock_class_priority_map}
 */
-extern int bt_clock_class_priority_map_get_clock_class_count(
+extern int64_t bt_clock_class_priority_map_get_clock_class_count(
                struct bt_clock_class_priority_map *clock_class_priority_map);
 
 /**
@@ -129,9 +139,10 @@ extern int bt_clock_class_priority_map_get_clock_class_count(
 @sa bt_clock_class_priority_map_add_clock_class(): Adds a clock class
        to a clock class priority map.
 */
-extern struct bt_ctf_clock_class *bt_clock_class_priority_map_get_clock_class(
+extern struct bt_ctf_clock_class *
+bt_clock_class_priority_map_get_clock_class_by_index(
                struct bt_clock_class_priority_map *clock_class_priority_map,
-               unsigned int index);
+               uint64_t index);
 
 /**
 @brief  Returns the CTF IR clock class named \c name found in the clock
@@ -151,7 +162,7 @@ extern struct bt_ctf_clock_class *bt_clock_class_priority_map_get_clock_class(
 @postrefcountsame{clock_class_priority_map}
 @postsuccessrefcountretinc
 
-@sa bt_clock_class_priority_map_get_clock_class(): Returns the clock
+@sa bt_clock_class_priority_map_get_clock_class_by_index(): Returns the clock
        class contained in a given clock class priority map at
        a given index.
 @sa bt_clock_class_priority_map_get_highest_priority_clock_class():
@@ -188,7 +199,7 @@ this function returns.
 @postrefcountsame{clock_class_priority_map}
 @postsuccessrefcountretinc
 
-@sa bt_clock_class_priority_map_get_clock_class(): Returns the clock
+@sa bt_clock_class_priority_map_get_clock_class_by_index(): Returns the clock
        class contained in a given clock class priority map at
        a given index.
 @sa bt_clock_class_priority_map_get_clock_class_by_name(): Finds a
@@ -256,10 +267,11 @@ map.
 
 @prenotnull{clock_class_priority_map}
 @prenotnull{clock_class}
+@prehot{clock_class_priority_map}
 @postrefcountsame{clock_class_priority_map}
 @postsuccessrefcountinc{clock_class}
 
-@sa bt_clock_class_priority_map_get_clock_class(): Returns the clock
+@sa bt_clock_class_priority_map_get_clock_class_by_index(): Returns the clock
        class contained in a given clock class priority map
        at a given index.
 @sa bt_clock_class_priority_map_get_clock_class_by_name(): Finds a
@@ -269,6 +281,27 @@ extern int bt_clock_class_priority_map_add_clock_class(
                struct bt_clock_class_priority_map *clock_class_priority_map,
                struct bt_ctf_clock_class *clock_class, uint64_t priority);
 
+/**
+@brief Creates a copy of the clock class priority map
+       \p clock_class_priority_map.
+
+You can copy a frozen clock class priority map: the resulting copy is
+<em>not frozen</em>.
+
+@param[in] clock_class_priority_map    Clock class priority map to copy.
+@returns                               Copy of \p clock_class_priority_map
+                                       on success, or a negative value
+                                       on error.
+
+@prenotnull{clock_class_priority_map}
+@postrefcountsame{clock_class_priority_map}
+@postsuccessrefcountret1
+@post <strong>On success</strong>, the returned clock class priority map
+       is not frozen.
+*/
+extern struct bt_clock_class_priority_map *bt_clock_class_priority_map_copy(
+               struct bt_clock_class_priority_map *clock_class_priority_map);
+
 /** @} */
 
 #ifdef __cplusplus