Commit | Line | Data |
---|---|---|
1c822dfb JG |
1 | #ifndef BABELTRACE_CTF_IR_STREAM_CLASS_H |
2 | #define BABELTRACE_CTF_IR_STREAM_CLASS_H | |
3 | ||
4 | /* | |
5 | * BabelTrace - CTF IR: Stream Class | |
6 | * | |
7 | * Copyright 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
8 | * | |
9 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
10 | * | |
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: | |
17 | * | |
18 | * The above copyright notice and this permission notice shall be included in | |
19 | * all copies or substantial portions of the Software. | |
20 | * | |
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 | |
27 | * SOFTWARE. | |
28 | * | |
29 | * The Common Trace Format (CTF) Specification is available at | |
30 | * http://www.efficios.com/ctf | |
31 | */ | |
32 | ||
33 | #include <stdint.h> | |
34 | ||
35 | #ifdef __cplusplus | |
36 | extern "C" { | |
37 | #endif | |
38 | ||
39 | struct bt_ctf_event_class; | |
40 | struct bt_ctf_stream_class; | |
41 | struct bt_ctf_clock; | |
42 | ||
43 | /* | |
44 | * bt_ctf_stream_class_create: create a stream class. | |
45 | * | |
46 | * Allocate a new stream class of the given name. The creation of an event class | |
47 | * sets its reference count to 1. | |
48 | * | |
49 | * A stream class' packet context is a structure initialized with the following | |
50 | * fields: | |
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 | |
56 | * | |
57 | * A stream class's event header is a structure initialized the following | |
58 | * fields: | |
59 | * - uint32_t id | |
60 | * - uint64_t timestamp | |
61 | * | |
62 | * @param name Stream name, NULL to create an unnamed stream class. | |
63 | * | |
64 | * Returns an allocated stream class on success, NULL on error. | |
65 | */ | |
66 | extern struct bt_ctf_stream_class *bt_ctf_stream_class_create(const char *name); | |
67 | ||
1c822dfb JG |
68 | /* |
69 | * bt_ctf_stream_class_set_clock: assign a clock to a stream class. | |
70 | * | |
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. | |
76 | * | |
77 | * Note that an event class may only be added to one stream class. It | |
78 | * also becomes immutable. | |
79 | * | |
80 | * @param stream_class Stream class. | |
81 | * @param event_class Event class to add to the provided stream class. | |
82 | * | |
83 | * Returns 0 on success, a negative value on error. | |
84 | */ | |
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); | |
88 | ||
1c822dfb JG |
89 | /* |
90 | * bt_ctf_stream_class_get_packet_context_type: get the stream class' packet | |
91 | * context type. | |
92 | * | |
93 | * @param stream_class Stream class. | |
94 | * | |
95 | * Returns the packet context's type (a structure), NULL on error. | |
96 | */ | |
97 | extern struct bt_ctf_field_type *bt_ctf_stream_class_get_packet_context_type( | |
98 | struct bt_ctf_stream_class *stream_class); | |
99 | ||
1c822dfb JG |
100 | #ifdef __cplusplus |
101 | } | |
102 | #endif | |
103 | ||
104 | #endif /* BABELTRACE_CTF_IR_STREAM_CLASS_H */ |