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 ab0a8c7e534b5d290f9d3c2f8064430095dc4edb..b38d80d43a1777a5d268664029582cb48d967ce5 100644 (file)
--- a/include/babeltrace/ctf-ir/stream.h
+++ b/include/babeltrace/ctf-ir/stream.h
@@ -39,6 +39,16 @@ extern "C" {
 struct bt_ctf_event;
 struct bt_ctf_stream;
 
+/*
+ * bt_ctf_stream_get_stream_class: get a stream's class.
+ *
+ * @param stream Stream instance.
+ *
+ * Returns the stream's class, NULL on error.
+ */
+extern struct bt_ctf_stream_class *bt_ctf_stream_get_class(
+               struct bt_ctf_stream *stream);
+
 /*
  * bt_ctf_stream_get_discarded_events_count: get the number of discarded
  * events associated with this stream.
@@ -76,6 +86,9 @@ extern void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream *stream,
  * incrementing its reference count. The current packet is not flushed to disk
  * until the next call to bt_ctf_stream_flush.
  *
+ * The stream event context will be sampled for every appended event if
+ * a stream event context was defined.
+ *
  * @param stream Stream instance.
  * @param event Event instance to append to the stream's current packet.
  *
@@ -84,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.
  *
@@ -109,6 +147,31 @@ extern int bt_ctf_stream_set_packet_context(
                struct bt_ctf_stream *stream,
                struct bt_ctf_field *packet_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_header(
+               struct bt_ctf_stream *stream);
+
+/*
+ * bt_ctf_stream_set_event_header: set a stream's event header.
+ *
+ * The event header's type must match the stream class' event
+ * header type.
+ *
+ * @param stream Stream instance.
+ * @param event_header Event header field instance.
+ *
+ * Returns a field instance on success, NULL on error.
+ */
+extern int bt_ctf_stream_set_event_context(
+               struct bt_ctf_stream *stream,
+               struct bt_ctf_field *event_context);
+
 /*
  * bt_ctf_stream_get_event_context: get a stream's event context.
  *