1 #ifndef BABELTRACE_CTF_IR_STREAM_CLASS_H
2 #define BABELTRACE_CTF_IR_STREAM_CLASS_H
5 * BabelTrace - CTF IR: Stream Class
7 * Copyright 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
39 struct bt_ctf_event_class
;
40 struct bt_ctf_stream_class
;
44 * bt_ctf_stream_class_create: create a stream class.
46 * Allocate a new stream class of the given name. The creation of an event class
47 * sets its reference count to 1.
49 * A stream class' packet context is a structure initialized with the following
51 * - uint64_t timestamp_begin
52 * - uint64_t timestamp_end
53 * - uint64_t content_size
54 * - uint64_t packet_size
55 * - uint64_t events_discarded
57 * A stream class's event header is a structure initialized the following
60 * - uint64_t timestamp
62 * @param name Stream name, NULL to create an unnamed stream class.
64 * Returns an allocated stream class on success, NULL on error.
66 extern struct bt_ctf_stream_class
*bt_ctf_stream_class_create(const char *name
);
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 * Note that an event class may only be added to one stream class. It
78 * also becomes immutable.
80 * @param stream_class Stream class.
81 * @param event_class Event class to add to the provided stream class.
83 * Returns 0 on success, a negative value on error.
85 extern int bt_ctf_stream_class_add_event_class(
86 struct bt_ctf_stream_class
*stream_class
,
87 struct bt_ctf_event_class
*event_class
);
90 * bt_ctf_stream_class_get_packet_context_type: get the stream class' packet
93 * @param stream_class Stream class.
95 * Returns the packet context's type (a structure), NULL on error.
97 extern struct bt_ctf_field_type
*bt_ctf_stream_class_get_packet_context_type(
98 struct bt_ctf_stream_class
*stream_class
);
104 #endif /* BABELTRACE_CTF_IR_STREAM_CLASS_H */
This page took 0.031309 seconds and 4 git commands to generate.