1 #ifndef BABELTRACE_CTF_IR_STREAM_H
2 #define BABELTRACE_CTF_IR_STREAM_H
5 * BabelTrace - CTF IR: Stream
7 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
11 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 * The Common Trace Format (CTF) Specification is available at
30 * http://www.efficios.com/ctf
33 #include <babeltrace/ctf-ir/stream-class.h>
41 @defgroup ctfirstream CTF IR stream
46 #include <babeltrace/ctf-ir/stream.h>
50 See \ref ctfwriterstream which documents additional CTF IR stream
51 functions exclusive to the CTF writer mode.
53 A CTF IR <strong><em>stream</em></strong> is an instance of a
54 \link ctfirstreamclass CTF IR stream class\endlink.
56 You can obtain a CTF IR stream object in two different modes:
58 - <strong>Normal mode</strong>: use bt_ctf_stream_create() with a stream
59 class having a \link ctfirtraceclass CTF IR trace class\endlink parent
60 \em not created by a \link ctfwriter CTF writer\endlink object to
61 create a default stream.
62 - <strong>CTF writer mode</strong>: use bt_ctf_stream_create() with
63 a stream class having a trace class parent created by a CTF writer
64 object, or use bt_ctf_writer_create_stream().
66 A CTF IR stream object represents a CTF stream, that is, a sequence of
67 packets containing events:
71 A CTF IR stream does not contain, however, actual \link ctfirpacket CTF
72 IR packet\endlink objects: it only acts as a common parent to identify
73 the original CTF stream of packet objects.
75 As with any Babeltrace object, CTF IR stream objects have
76 <a href="https://en.wikipedia.org/wiki/Reference_counting">reference
77 counts</a>. See \ref refs to learn more about the reference counting
78 management of Babeltrace objects.
85 @brief CTF IR stream type and functions.
88 @addtogroup ctfirstream
94 @brief A CTF IR stream.
102 @brief Creates a default CTF IR stream named \p name from the CTF IR
103 stream class \p stream_class.
105 \p stream_class \em must have a parent
106 \link ctfirtraceclass CTF IR trace class\endlink.
108 If the parent \link ctfirtraceclass trace class\endlink of
109 \p stream_class was created by a \link ctfwriter CTF writer\endlink
110 object, then the stream object is created in CTF writer mode, and
111 you can use the functions of \ref ctfwriterstream on it.
112 Otherwise it is created in normal mode: you should only use the
113 functions documented in this module on it.
115 \p name can be \c NULL to create an unnamed stream object.
117 @param[in] stream_class CTF IR stream class to use to create the
119 @param[in] name Name of the stream object to create (copied on
120 success) or \c NULL to create an unnamed stream.
121 @returns Created stream object, or \c NULL on error.
123 @prenotnull{stream_class}
124 @pre \p stream_class has a parent trace class.
125 @postsuccessrefcountret1
127 extern struct bt_ctf_stream
*bt_ctf_stream_create(
128 struct bt_ctf_stream_class
*stream_class
,
132 @brief Returns the name of the CTF IR stream \p stream.
134 On success, \p stream remains the sole owner of the returned string.
136 @param[in] stream Stream object of which to get the name.
137 @returns Name of stream \p stream, or \c NULL if
138 \p stream is unnamed or on error.
141 @postrefcountsame{stream}
143 extern const char *bt_ctf_stream_get_name(struct bt_ctf_stream
*stream
);
146 @brief Returns the parent CTF IR stream class of the CTF IR
149 This function returns a reference to the stream class which was used
150 to create the stream object in the first place with
151 bt_ctf_stream_create().
153 @param[in] stream Stream of which to get the parent stream class.
154 @returns Parent stream class of \p stream,
158 @postrefcountsame{stream}
159 @postsuccessrefcountretinc
161 extern struct bt_ctf_stream_class
*bt_ctf_stream_get_class(
162 struct bt_ctf_stream
*stream
);
170 #endif /* BABELTRACE_CTF_IR_STREAM_H */
This page took 0.033694 seconds and 4 git commands to generate.