1 #ifndef BABELTRACE_CTF_WRITER_STREAM_CLASS_H
2 #define BABELTRACE_CTF_WRITER_STREAM_CLASS_H
5 * BabelTrace - CTF Writer: Stream Class
7 * Copyright 2014 EfficiOS Inc.
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
37 struct bt_ctf_event_class
;
38 struct bt_ctf_stream_class
;
42 * bt_ctf_stream_class_create: create a stream class.
44 * Allocate a new stream class of the given name. The creation of an event class
45 * sets its reference count to 1.
47 * @param name Stream name.
49 * Returns an allocated stream class on success, NULL on error.
51 extern struct bt_ctf_stream_class
*bt_ctf_stream_class_create(const char *name
);
54 * bt_ctf_stream_class_set_clock: assign a clock to a stream class.
56 * Assign a clock to a stream class. This clock will be sampled each time an
57 * event is appended to an instance of this stream class.
59 * @param stream_class Stream class.
60 * @param clock Clock to assign to the provided stream class.
62 * Returns 0 on success, a negative value on error.
64 extern int bt_ctf_stream_class_set_clock(
65 struct bt_ctf_stream_class
*stream_class
,
66 struct bt_ctf_clock
*clock
);
69 * bt_ctf_stream_class_set_clock: assign a clock to a stream class.
71 * Add an event class to a stream class. New events can be added even after a
72 * stream has beem instanciated and events have been appended. However, a stream
73 * will not accept events of a class that has not been registered beforehand.
74 * The stream class will share the ownership of "event_class" by incrementing
75 * its reference count.
77 * @param stream_class Stream class.
78 * @param event_class Event class to add to the provided stream class.
80 * Returns 0 on success, a negative value on error.
82 extern int bt_ctf_stream_class_add_event_class(
83 struct bt_ctf_stream_class
*stream_class
,
84 struct bt_ctf_event_class
*event_class
);
87 * bt_ctf_stream_class_get and bt_ctf_stream_class_put: increment and
88 * decrement the stream class' reference count.
90 * These functions ensure that the stream class won't be destroyed while it
91 * is in use. The same number of get and put (plus one extra put to
92 * release the initial reference done at creation) have to be done to
93 * destroy a stream class.
95 * When the stream class' reference count is decremented to 0 by a
96 * bt_ctf_stream_class_put, the stream class is freed.
98 * @param stream_class Stream class.
100 extern void bt_ctf_stream_class_get(struct bt_ctf_stream_class
*stream_class
);
101 extern void bt_ctf_stream_class_put(struct bt_ctf_stream_class
*stream_class
);
107 #endif /* BABELTRACE_CTF_WRITER_STREAM_CLASS_H */
This page took 0.036899 seconds and 6 git commands to generate.