ir: consolidate reference counting functions

[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..18f86a7c0949ca10e550d29a8443c616723b3aaa 100644 (file)
--- a/include/babeltrace/ctf-ir/stream.h
+++ b/include/babeltrace/ctf-ir/stream.h
@@ -31,6 +31,7 @@
  */
 
 #include <babeltrace/ctf-ir/stream-class.h>
+#include <stdint.h>
 
 #ifdef __cplusplus
 extern "C" {
@@ -39,6 +40,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 +87,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 +98,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 +148,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_header(
+               struct bt_ctf_stream *stream,
+               struct bt_ctf_field *event_header);
+
 /*
  * bt_ctf_stream_get_event_context: get a stream's event context.
  *
@@ -155,6 +219,8 @@ extern int bt_ctf_stream_flush(struct bt_ctf_stream *stream);
  * bt_ctf_stream_get and bt_ctf_stream_put: increment and decrement the
  * stream's reference count.
  *
+ * You may also use bt_ctf_get() and bt_ctf_put() with stream objects.
+ *
  * These functions ensure that the stream won't be destroyed while it
  * is in use. The same number of get and put (plus one extra put to
  * release the initial reference done at creation) have to be done to