@ingroup ctfir
@brief CTF IR stream class.
+@code
+#include <babeltrace/ctf-ir/stream-class.h>
+@endcode
+
+@note
+See \ref ctfirwriterstreamclass which documents additional CTF IR stream
+class functions exclusive to the CTF IR writer mode.
+
A CTF IR <strong><em>stream class</em></strong> is a template that you
can use to create concrete \link ctfirstream CTF IR streams\endlink.
- bt_ctf_trace_add_stream_class()
- bt_ctf_event_create()
- bt_ctf_writer_create_stream()
- (\link ctfirwriter CTF writer\endlink mode only)
+ (\link ctfirwriter CTF IR writer\endlink mode only)
You cannot modify a frozen stream class: it is considered immutable,
except for:
@sa ctfirstream
@sa ctfireventclass
@sa ctfirtraceclass
+@sa ctfirwriterstreamclass
@file
@brief CTF IR stream class type and functions.
added to a trace class yet or on error.
@prenotnull{stream_class}
+@postrefcountsame{stream_class}
@postsuccessrefcountretinc
@sa bt_ctf_trace_add_stream_class(): Add a stream class to
or \c NULL on error.
@prenotnull{stream_class}
+@postrefcountsame{stream_class}
@postsuccessrefcountretinc
@sa bt_ctf_stream_class_set_packet_context_type(): Sets the packet
or \c NULL on error.
@prenotnull{stream_class}
+@postrefcountsame{stream_class}
@postsuccessrefcountretinc
@sa bt_ctf_stream_class_set_event_header_type(): Sets the event
\p stream_class, or \c NULL on error.
@prenotnull{stream_class}
+@postrefcountsame{stream_class}
@postsuccessrefcountretinc
@sa bt_ctf_stream_class_set_event_context_type(): Sets the per-stream
@prehot{event_class}
@postrefcountsame{stream_class}
@postsuccessrefcountinc{event_class}
+@postsuccessfrozen{event_class}
*/
extern int bt_ctf_stream_class_add_event_class(
struct bt_ctf_stream_class *stream_class,
@prenotnull{visitor}
*/
extern int bt_ctf_stream_class_visit(struct bt_ctf_stream_class *stream_class,
- bt_ctf_ir_visitor visitor, void *data);
+ bt_ctf_visitor visitor, void *data);
/** @} */