ir: move the stream event ctx field to the event

[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..ba43f0d5b276d501472898bce92b6501114c1ef7 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" {
@@ -98,79 +99,79 @@ extern int bt_ctf_stream_append_event(struct bt_ctf_stream *stream,
                struct bt_ctf_event *event);
 
 /*
- * bt_ctf_stream_get_packet_context: get a stream's packet context.
+ * 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_context(
+extern struct bt_ctf_field *bt_ctf_stream_get_packet_header(
                struct bt_ctf_stream *stream);
 
 /*
- * bt_ctf_stream_set_packet_context: set a stream's packet context.
+ * bt_ctf_stream_set_packet_header: set a stream's packet header.
  *
- * The packet context's type must match the stream class' packet
- * context type.
+ * The packet header's type must match the trace's packet header
+ * type.
  *
  * @param stream Stream instance.
- * @param packet_context Packet context field instance.
+ * @param packet_header Packet header instance.
  *
  * Returns a field instance on success, NULL on error.
  */
-extern int bt_ctf_stream_set_packet_context(
+extern int bt_ctf_stream_set_packet_header(
                struct bt_ctf_stream *stream,
-               struct bt_ctf_field *packet_context);
+               struct bt_ctf_field *packet_header);
 
 /*
- * bt_ctf_stream_get_event_context: get a stream's event context.
+ * bt_ctf_stream_get_packet_context: get a stream's packet context.
  *
  * @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_packet_context(
                struct bt_ctf_stream *stream);
 
 /*
- * bt_ctf_stream_set_event_context: set a stream's event context.
+ * bt_ctf_stream_set_packet_context: set a stream's packet context.
  *
- * The event context's type must match the stream class' event
+ * The packet context's type must match the stream class' packet
  * context type.
  *
  * @param stream Stream instance.
- * @param event_context Event context field instance.
+ * @param packet_context Packet context field instance.
  *
  * Returns a field instance on success, NULL on error.
  */
-extern int bt_ctf_stream_set_event_context(
+extern int bt_ctf_stream_set_packet_context(
                struct bt_ctf_stream *stream,
-               struct bt_ctf_field *event_context);
+               struct bt_ctf_field *packet_context);
 
 /*
- * bt_ctf_stream_get_packet_header: get a stream's packet header.
+ * 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_packet_header(
+extern struct bt_ctf_field *bt_ctf_stream_get_event_header(
                struct bt_ctf_stream *stream);
 
 /*
- * bt_ctf_stream_set_packet_header: set a stream's packet header.
+ * bt_ctf_stream_set_event_header: set a stream's event header.
  *
- * The packet header's type must match the trace's packet header
- * type.
+ * The event header's type must match the stream class' event
+ * header type.
  *
  * @param stream Stream instance.
- * @param packet_header Packet header instance.
+ * @param event_header Event header 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_header(
                struct bt_ctf_stream *stream,
-               struct bt_ctf_field *packet_header);
+               struct bt_ctf_field *event_header);
 
 /*
  * bt_ctf_stream_flush: flush a stream.
@@ -193,6 +194,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