Docs: event class must have a stream class before events may be created

[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 948747a929a3d1b9d7359d0cbdba1e84e894c4d9..30b790035456eefbd4ffff13a3fe45e09522b7c0 100644 (file)
--- a/include/babeltrace/ctf-ir/event.h
+++ b/include/babeltrace/ctf-ir/event.h
@@ -202,6 +202,9 @@ extern void bt_ctf_event_class_put(struct bt_ctf_event_class *event_class);
  * sets its reference count to 1. Each instance shares the ownership of the
  * event class using its reference count.
  *
+ * An event class must be associated with a stream class before events
+ * may be instanciated.
+ *
  * @param event_class Event class.
  *
  * Returns an allocated field type on success, NULL on error.
@@ -275,6 +278,31 @@ extern int bt_ctf_event_set_payload(struct bt_ctf_event *event,
 extern struct bt_ctf_field *bt_ctf_event_get_payload_by_index(
                struct bt_ctf_event *event, int index);
 
+/*
+ * bt_ctf_event_get_header: get an event's header.
+ *
+ * @param event Event instance.
+ *
+ * Returns a field instance on success, NULL on error.
+ */
+extern struct bt_ctf_field *bt_ctf_event_get_header(
+               struct bt_ctf_event *event);
+
+/*
+ * bt_ctf_event_set_header: set an event's header.
+ *
+ * The event header's type must match the stream class' event
+ * header type.
+ *
+ * @param event Event instance.
+ * @param header Event header field instance.
+ *
+ * Returns a field instance on success, NULL on error.
+ */
+extern int bt_ctf_event_set_header(
+               struct bt_ctf_event *event,
+               struct bt_ctf_field *header);
+
 /*
  * bt_ctf_event_get_event_context: Get an event's context
  *