ir: consolidate reference counting functions

[babeltrace.git] / include / babeltrace / ctf-ir / clock.h

diff --git a/include/babeltrace/ctf-ir/clock.h b/include/babeltrace/ctf-ir/clock.h
index c1ae948a32af5f0c3ab83e8ef1d5cdd22179973d..1ac8ca9e36d99693d312914ec82e6dc80a767cb0 100644 (file)
--- a/include/babeltrace/ctf-ir/clock.h
+++ b/include/babeltrace/ctf-ir/clock.h
@@ -159,7 +159,7 @@ extern int bt_ctf_clock_set_offset_s(struct bt_ctf_clock *clock,
                uint64_t offset_s);
 
 /*
- * bt_ctf_clock_get_offset_s: get a clock's offset in ticks.
+ * bt_ctf_clock_get_offset: get a clock's offset in ticks.
  *
  * Get the clock's offset in ticks from Epoch + offset_t.
  *
@@ -208,6 +208,31 @@ extern int bt_ctf_clock_get_is_absolute(struct bt_ctf_clock *clock);
 extern int bt_ctf_clock_set_is_absolute(struct bt_ctf_clock *clock,
                int is_absolute);
 
+/*
+ * bt_ctf_clock_get_uuid: get a clock's UUID.
+ *
+ * Get the clock's UUID.
+ *
+ * @param clock Clock instance.
+ *
+ * Returns a pointer to the clock's UUID (16 byte array) on success,
+ * NULL on error.
+ */
+extern const unsigned char *bt_ctf_clock_get_uuid(struct bt_ctf_clock *clock);
+
+/*
+ * bt_ctf_clock_set_uuid: set a clock's UUID.
+ *
+ * Set a clock's UUID.
+ *
+ * @param clock Clock instance.
+ * @param uuid A 16-byte array containing a UUID.
+ *
+ * Returns 0 on success, a negative value on error.
+ */
+extern int bt_ctf_clock_set_uuid(struct bt_ctf_clock *clock,
+               const unsigned char *uuid);
+
 /*
  * bt_ctf_clock_get_time: get a clock's current time value.
  *
@@ -233,6 +258,8 @@ extern int bt_ctf_clock_set_time(struct bt_ctf_clock *clock,
  * bt_ctf_clock_get and bt_ctf_clock_put: increment and decrement the
  * refcount of the clock
  *
+ * You may also use bt_ctf_get() and bt_ctf_put() with clock objects.
+ *
  * These functions ensure that the clock won't be destroyed when it
  * is in use. The same number of get and put (plus one extra put to
  * release the initial reference done at creation) has to be done to