Add event header accessors and support for custom event headers

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

diff --git a/include/babeltrace/ctf-ir/stream.h b/include/babeltrace/ctf-ir/stream.h
index f302583d8fa74ecbf0ffb1908844689ca2ab8cca..b38d80d43a1777a5d268664029582cb48d967ce5 100644 (file)
--- a/include/babeltrace/ctf-ir/stream.h
+++ b/include/babeltrace/ctf-ir/stream.h
@@ -97,6 +97,31 @@ extern void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream *stream,
 extern int bt_ctf_stream_append_event(struct bt_ctf_stream *stream,
                struct bt_ctf_event *event);
 
+/*
+ * bt_ctf_stream_get_packet_header: get a stream's packet header.
+ *
+ * @param stream Stream instance.
+ *
+ * Returns a field instance on success, NULL on error.
+ */
+extern struct bt_ctf_field *bt_ctf_stream_get_packet_header(
+               struct bt_ctf_stream *stream);
+
+/*
+ * bt_ctf_stream_set_packet_header: set a stream's packet header.
+ *
+ * The packet header's type must match the trace's packet header
+ * type.
+ *
+ * @param stream Stream instance.
+ * @param packet_header Packet header instance.
+ *
+ * Returns a field instance on success, NULL on error.
+ */
+extern int bt_ctf_stream_set_packet_header(
+               struct bt_ctf_stream *stream,
+               struct bt_ctf_field *packet_header);
+
 /*
  * bt_ctf_stream_get_packet_context: get a stream's packet context.
  *
@@ -123,23 +148,23 @@ extern int bt_ctf_stream_set_packet_context(
                struct bt_ctf_field *packet_context);
 
 /*
- * bt_ctf_stream_get_event_context: get a stream's event context.
+ * bt_ctf_stream_get_event_header: get a stream's event header.
  *
  * @param stream Stream instance.
  *
  * Returns a field instance on success, NULL on error.
  */
-extern struct bt_ctf_field *bt_ctf_stream_get_event_context(
+extern struct bt_ctf_field *bt_ctf_stream_get_event_header(
                struct bt_ctf_stream *stream);
 
 /*
- * bt_ctf_stream_set_event_context: set a stream's event context.
+ * bt_ctf_stream_set_event_header: set a stream's event header.
  *
- * The event context's type must match the stream class' event
- * context type.
+ * The event header's type must match the stream class' event
+ * header type.
  *
  * @param stream Stream instance.
- * @param event_context Event context field instance.
+ * @param event_header Event header field instance.
  *
  * Returns a field instance on success, NULL on error.
  */
@@ -148,29 +173,29 @@ extern int bt_ctf_stream_set_event_context(
                struct bt_ctf_field *event_context);
 
 /*
- * bt_ctf_stream_get_packet_header: get a stream's packet header.
+ * bt_ctf_stream_get_event_context: get a stream's event context.
  *
  * @param stream Stream instance.
  *
  * Returns a field instance on success, NULL on error.
  */
-extern struct bt_ctf_field *bt_ctf_stream_get_packet_header(
+extern struct bt_ctf_field *bt_ctf_stream_get_event_context(
                struct bt_ctf_stream *stream);
 
 /*
- * bt_ctf_stream_set_packet_header: set a stream's packet header.
+ * bt_ctf_stream_set_event_context: set a stream's event context.
  *
- * The packet header's type must match the trace's packet header
- * type.
+ * The event context's type must match the stream class' event
+ * context type.
  *
  * @param stream Stream instance.
- * @param packet_header Packet header instance.
+ * @param event_context Event context field instance.
  *
  * Returns a field instance on success, NULL on error.
  */
-extern int bt_ctf_stream_set_packet_header(
+extern int bt_ctf_stream_set_event_context(
                struct bt_ctf_stream *stream,
-               struct bt_ctf_field *packet_header);
+               struct bt_ctf_field *event_context);
 
 /*
  * bt_ctf_stream_flush: flush a stream.