X-Git-Url: https://git.efficios.com/?a=blobdiff_plain;f=include%2Fbabeltrace%2Fctf-ir%2Fclock.h;h=e149d7fadb684f7ce0da904498ea62eb33cc9f0b;hb=61cf588beae752e5ddfc60b6b5310f769ac9e852;hp=cad2eec92df116bb4d936994dc439651eedc127d;hpb=ffa6d162196887d986aba83b4ec7b0d3ba3b250a;p=babeltrace.git diff --git a/include/babeltrace/ctf-ir/clock.h b/include/babeltrace/ctf-ir/clock.h index cad2eec9..e149d7fa 100644 --- a/include/babeltrace/ctf-ir/clock.h +++ b/include/babeltrace/ctf-ir/clock.h @@ -139,10 +139,12 @@ extern int bt_ctf_clock_set_precision(struct bt_ctf_clock *clock, * Get the clock's offset in seconds from POSIX.1 Epoch, 1970-01-01. * * @param clock Clock instance. + * @param offset_s Pointer to clock offset in seconds (output). * - * Returns the clock's offset in seconds, -1ULL on error. + * Returns 0 on success, a negative value on error. */ -extern uint64_t bt_ctf_clock_get_offset_s(struct bt_ctf_clock *clock); +extern int bt_ctf_clock_get_offset_s(struct bt_ctf_clock *clock, + int64_t *offset_s); /* * bt_ctf_clock_set_offset_s: set a clock's offset in seconds. @@ -156,7 +158,7 @@ extern uint64_t bt_ctf_clock_get_offset_s(struct bt_ctf_clock *clock); * Returns 0 on success, a negative value on error. */ extern int bt_ctf_clock_set_offset_s(struct bt_ctf_clock *clock, - uint64_t offset_s); + int64_t offset_s); /* * bt_ctf_clock_get_offset: get a clock's offset in ticks. @@ -164,10 +166,12 @@ extern int bt_ctf_clock_set_offset_s(struct bt_ctf_clock *clock, * Get the clock's offset in ticks from Epoch + offset_t. * * @param clock Clock instance. + * @param offset Clock offset in ticks from Epoch + offset_s (output). * - * Returns the clock's offset in ticks from Epoch + offset_s, -1ULL on error. + * Returns 0 on success, a negative value on error. */ -extern uint64_t bt_ctf_clock_get_offset(struct bt_ctf_clock *clock); +extern int bt_ctf_clock_get_offset(struct bt_ctf_clock *clock, + int64_t *offset); /* * bt_ctf_clock_set_offset: set a clock's offset in ticks. @@ -180,7 +184,7 @@ extern uint64_t bt_ctf_clock_get_offset(struct bt_ctf_clock *clock); * Returns 0 on success, a negative value on error. */ extern int bt_ctf_clock_set_offset(struct bt_ctf_clock *clock, - uint64_t offset); + int64_t offset); /* * bt_ctf_clock_get_is_absolute: get a clock's absolute attribute. @@ -239,9 +243,13 @@ extern int bt_ctf_clock_set_uuid(struct bt_ctf_clock *clock, * Get the current time in nanoseconds since the clock's origin (offset and * offset_s attributes). * - * Returns the clock's current time value, -1ULL on error. + * @param clock Clock instance. + * @param time Clock current time value (output). + * + * Returns 0 on success, a negative value on error. */ -extern uint64_t bt_ctf_clock_get_time(struct bt_ctf_clock *clock); +extern int bt_ctf_clock_get_time(struct bt_ctf_clock *clock, + int64_t *time); /* * bt_ctf_clock_set_time: set a clock's current time value. @@ -252,12 +260,14 @@ extern uint64_t bt_ctf_clock_get_time(struct bt_ctf_clock *clock); * Returns 0 on success, a negative value on error. */ extern int bt_ctf_clock_set_time(struct bt_ctf_clock *clock, - uint64_t time); + int64_t time); /* * 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