@ingroup ctfir
@brief CTF IR trace class.
+@code
+#include <babeltrace/ctf-ir/trace.h>
+@endcode
+
A CTF IR <strong><em>trace class</em></strong> is a descriptor of
traces.
@param[in] trace_class Trace class of which to get the packet
header field type.
@returns Packet header field type of \p trace_class,
- or \c NULL on error.
+ or \c NULL if \p trace_class has no packet header field
+ type or on error.
@prenotnull{trace_class}
-@postsuccessrefcountretinc
+@postrefcountsame{trace_class}
+@post <strong>On success, if the return value is a field type</strong>, its
+ reference count is incremented.
@sa bt_ctf_trace_set_packet_header_type(): Sets the packet
header field type of a given trace class.
/**
@brief Sets the packet header field type of the CTF IR trace class
- \p trace_class to \p packet_context_type.
+ \p trace_class to \p packet_header_type, or unsets the current packet
+ header field type from \p trace_class.
-As of Babeltrace \btversion, \p packet_context_type \em must be a
-CTF IR structure field type object.
+If \p packet_header_type is \c NULL, then this function unsets the current
+packet header field type from \p trace_class, effectively making \p trace_class
+a trace without a packet header field type.
+
+As of Babeltrace \btversion, if \p packet_header_type is not \c NULL,
+\p packet_header_type \em must be a CTF IR structure field type object.
@param[in] trace_class Trace class of which to set the packet
header field type.
-@param[in] packet_header_type Packet header field type.
+@param[in] packet_header_type Packet header field type, or \c NULL to unset
+ the current packet header field type.
@returns 0 on success, or a negative value on error.
@prenotnull{trace_class}
-@prenotnull{packet_header_type}
@prehot{trace_class}
-@preisstructft{packet_header_type}
+@pre <strong>\p packet_header_type, if not \c NULL</strong>, is a CTF IR
+ structure field type.
@postrefcountsame{trace_class}
-@postsuccessrefcountinc{packet_header_type}
+@post <strong>On success, if \p packet_header_type is not \c NULL</strong>,
+ the reference count of \p packet_header_type is incremented.
@sa bt_ctf_trace_get_packet_header_type(): Returns the packet
header field type of a given trace class.
@prenotnull{clock_class}
@postrefcountsame{trace_class}
@postsuccessrefcountinc{clock_class}
-@post <strong>On success, if \p trace_class is frozen<strong>,
+@post <strong>On success, if \p trace_class is frozen</strong>,
\p clock_class is frozen.
@sa bt_ctf_trace_get_clock(): Returns the clock class contained in a
You can call this function even if \p trace_class is frozen.
+This function tries to resolve the needed
+\link ctfirfieldtypes CTF IR field type\endlink of the dynamic field
+types that are found anywhere in the root field types of
+\p stream_class and of all its currently contained
+\link ctfireventclass CTF IR event classes\endlink. If any automatic
+resolving fails, then this function fails.
+
@param[in] trace_class Trace class to which to add \p stream_class.
@param[in] stream_class Stream class to add to \p trace_class.
@returns 0 on success, or a negative value on error.
@prenotnull{trace_class}
@prenotnull{listener}
+@postrefcountsame{trace_class}
*/
extern int bt_ctf_trace_add_listener(struct bt_ctf_trace *trace_class,
bt_ctf_listener_cb listener, void *data);