Add event header accessors and support for custom event headers

[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 7daab39578c24882dc18c868251d93b6faa01372..c6b30960cb6a023eda08c46d10f0be1f52a59592 100644 (file)
--- a/include/babeltrace/ctf-ir/event.h
+++ b/include/babeltrace/ctf-ir/event.h
@@ -126,7 +126,7 @@ extern int bt_ctf_event_class_add_field(struct bt_ctf_event_class *event_class,
  *
  * Returns the event class' field count, a negative value on error.
  */
-extern int64_t bt_ctf_event_class_get_field_count(
+extern int bt_ctf_event_class_get_field_count(
                struct bt_ctf_event_class *event_class);
 
 /*
@@ -143,7 +143,7 @@ extern int64_t bt_ctf_event_class_get_field_count(
  */
 extern int bt_ctf_event_class_get_field(struct bt_ctf_event_class *event_class,
                const char **field_name, struct bt_ctf_field_type **field_type,
-               size_t index);
+               int index);
 
 /*
  * bt_ctf_event_class_get_field_type_by_name: Get an event class's field by name
@@ -157,7 +157,29 @@ 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 and bt_ctf_event_class_put: increment and decrement
+ * 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.
  *
  * These functions ensure that the event class won't be destroyed while it
@@ -251,7 +273,58 @@ extern int bt_ctf_event_set_payload(struct bt_ctf_event *event,
  * Returns the event's field, NULL on error.
  */
 extern struct bt_ctf_field *bt_ctf_event_get_payload_by_index(
-               struct bt_ctf_event *event, size_t 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