ir: consolidate reference counting functions

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

diff --git a/include/babeltrace/ctf-ir/event.h b/include/babeltrace/ctf-ir/event.h
index 63bd74e584edcec2372b248ba530b31247fa3053..4c90a2eb5759c6bb2952de67bbe38dbcb03df4c2 100644 (file)
--- a/include/babeltrace/ctf-ir/event.h
+++ b/include/babeltrace/ctf-ir/event.h
@@ -307,6 +307,8 @@ extern int bt_ctf_event_class_set_context_type(
  * bt_ctf_event_class_get and bt_ctf_event_class_put: increment and decrement
  * the event class' reference count.
  *
+ * You may also use bt_ctf_get() and bt_ctf_put() with event class objects.
+ *
  * These functions ensure that the event class won't be destroyed while it
  * is in use. The same number of get and put (plus one extra put to
  * release the initial reference done at creation) have to be done to
@@ -367,6 +369,27 @@ extern struct bt_ctf_stream *bt_ctf_event_get_stream(
 extern struct bt_ctf_clock *bt_ctf_event_get_clock(
                struct bt_ctf_event *event);
 
+/*
+ * bt_ctf_event_get_payload_field: get an event's payload.
+ *
+ * @param event Event instance.
+ *
+ * Returns a field instance on success, NULL on error.
+ */
+extern struct bt_ctf_field *bt_ctf_event_get_payload_field(
+               struct bt_ctf_event *event);
+
+/*
+ * bt_ctf_event_set_payload_field: set an event's payload.
+ *
+ * @param event Event instance.
+ * @param payload Field instance (must be a structure).
+ *
+ * Returns 0 on success, a negative value on error.
+ */
+extern int bt_ctf_event_set_payload_field(struct bt_ctf_event *event,
+               struct bt_ctf_field *payload);
+
 /*
  * bt_ctf_event_get_payload: get an event's field.
  *
@@ -491,6 +514,8 @@ extern struct bt_ctf_event *bt_ctf_event_copy(struct bt_ctf_event *event);
  * bt_ctf_event_get and bt_ctf_event_put: increment and decrement
  * the event's reference count.
  *
+ * You may also use bt_ctf_get() and bt_ctf_put() with event objects.
+ *
  * These functions ensure that the event won't be destroyed while it
  * is in use. The same number of get and put (plus one extra put to
  * release the initial reference done at creation) have to be done to