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 fcf82629fec85ef5da46fdfe3aa479f643594564..30b790035456eefbd4ffff13a3fe45e09522b7c0 100644 (file)
--- a/include/babeltrace/ctf-ir/event.h
+++ b/include/babeltrace/ctf-ir/event.h
@@ -156,6 +156,28 @@ extern int bt_ctf_event_class_get_field(struct bt_ctf_event_class *event_class,
 extern struct bt_ctf_field_type *bt_ctf_event_class_get_field_by_name(
                struct bt_ctf_event_class *event_class, const char *name);
 
+/*
+ * bt_ctf_event_class_get_context_type: Get an event class's context type
+ *
+ * @param event_class Event class.
+ *
+ * Returns a field type (a structure) on success, NULL on error.
+ */
+extern struct bt_ctf_field_type *bt_ctf_event_class_get_context_type(
+               struct bt_ctf_event_class *event_class);
+
+/*
+ * bt_ctf_event_class_set_context_type: Set an event class's context type
+ *
+ * @param event_class Event class.
+ * @param context Event context field type (must be a structure).
+ *
+ * Returns 0 on success, a negative value on error.
+ */
+extern int bt_ctf_event_class_set_context_type(
+               struct bt_ctf_event_class *event_class,
+               struct bt_ctf_field_type *context);
+
 /*
  * bt_ctf_event_class_get and bt_ctf_event_class_put: increment and decrement
  * the event class' reference count.
@@ -180,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.
@@ -253,6 +278,57 @@ 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
+ *
+ * @param event_class Event class.
+ *
+ * Returns a field on success (a structure), NULL on error.
+ *
+ * Note: This function is named this way instead of the expected
+ * "bt_ctf_event_get_context" in order to work around a name clash with
+ * an unrelated function bearing this name in context.h.
+ */
+extern struct bt_ctf_field *bt_ctf_event_get_event_context(
+               struct bt_ctf_event *event);
+
+/*
+ * bt_ctf_event_set_event_context: Set an event's context
+ *
+ * @param event Event.
+ * @param context Event context field (must match the event class'
+ *     context type).
+ *
+ * Returns 0 on success, a negative value on error.
+ */
+extern int bt_ctf_event_set_event_context(struct bt_ctf_event *event,
+               struct bt_ctf_field *context);
+
 /*
  * bt_ctf_event_get and bt_ctf_event_put: increment and decrement
  * the event's reference count.