*/
#include <babeltrace/ctf-ir/stream-class.h>
+#include <stdint.h>
#ifdef __cplusplus
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.
+ *
+ * Note that discarded events are not stored if the stream's packet
+ * context has no "events_discarded" field. An error will be returned
+ * in that case.
+ *
+ * @param stream Stream instance.
+ *
+ * Returns the number of discarded events, a negative value on error.
+ */
+extern int bt_ctf_stream_get_discarded_events_count(
+ struct bt_ctf_stream *stream, uint64_t *count);
+
/*
* bt_ctf_stream_append_discarded_events: increment discarded events count.
*
- * Increase the current packet's discarded event count.
+ * Increase the current packet's discarded event count. Has no effect if the
+ * stream class' packet context has no "events_discarded" field.
*
* @param stream Stream instance.
* @param event_count Number of discarded events to add to the stream's current
* 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.
*
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.
+ *
+ * @param stream Stream instance.
+ *
+ * Returns a field instance on success, NULL on error.
+ */
+extern struct bt_ctf_field *bt_ctf_stream_get_packet_context(
+ struct bt_ctf_stream *stream);
+
+/*
+ * bt_ctf_stream_set_packet_context: set a stream's packet context.
+ *
+ * The packet context's type must match the stream class' packet
+ * context type.
+ *
+ * @param stream Stream instance.
+ * @param packet_context Packet context field instance.
+ *
+ * Returns a field instance on success, NULL on error.
+ */
+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.
+ *
+ * @param stream Stream instance.
+ *
+ * Returns a field instance on success, NULL on error.
+ */
+extern struct bt_ctf_field *bt_ctf_stream_get_event_context(
+ struct bt_ctf_stream *stream);
+
+/*
+ * bt_ctf_stream_set_event_context: set a stream's event context.
+ *
+ * The event context's type must match the stream class' event
+ * context type.
+ *
+ * @param stream Stream instance.
+ * @param event_context Event context 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_flush: flush a stream.
*
- * The stream's current packet's events will be flushed to disk. Events
- * subsequently appended to the stream will be added to a new packet.
+ * The stream's current packet's events will be flushed, thus closing the
+ * current packet. Events subsequently appended to the stream will be
+ * added to a new packet.
+ *
+ * Flushing will also set the packet context's default attributes if
+ * they remained unset while populating the current packet. These default
+ * attributes, along with their expected types, are detailed in stream-class.h.
*
* @param stream Stream instance.
*
* 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
projects / babeltrace.git / blobdiff