Commit | Line | Data |
---|---|---|
adc315b8 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 | * | |
de9dd397 | 7 | * Copyright 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
adc315b8 JG |
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 | ||
48d711a2 | 33 | #include <stdint.h> |
9d408fca | 34 | |
44c440bc PP |
35 | /* For bt_bool */ |
36 | #include <babeltrace/types.h> | |
48d711a2 | 37 | |
adc315b8 JG |
38 | #ifdef __cplusplus |
39 | extern "C" { | |
40 | #endif | |
41 | ||
44c440bc | 42 | struct bt_trace; |
50842bdc PP |
43 | struct bt_stream_class; |
44 | struct bt_event_class; | |
44c440bc | 45 | struct bt_clock_class; |
312c056a PP |
46 | struct bt_event_header_field; |
47 | struct bt_packet_context_field; | |
adc315b8 | 48 | |
44c440bc | 49 | extern struct bt_stream_class *bt_stream_class_create(struct bt_trace *trace); |
594a3fb7 | 50 | |
44c440bc PP |
51 | extern struct bt_stream_class *bt_stream_class_create_with_id( |
52 | struct bt_trace *trace, uint64_t id); | |
adc315b8 | 53 | |
094ff7c0 PP |
54 | extern struct bt_trace *bt_stream_class_borrow_trace( |
55 | struct bt_stream_class *stream_class); | |
56 | ||
50842bdc PP |
57 | extern const char *bt_stream_class_get_name( |
58 | struct bt_stream_class *stream_class); | |
69dc4535 | 59 | |
44c440bc PP |
60 | extern int bt_stream_class_set_name(struct bt_stream_class *stream_class, |
61 | const char *name); | |
594a3fb7 | 62 | |
44c440bc PP |
63 | extern bt_bool bt_stream_class_assigns_automatic_event_class_id( |
64 | struct bt_stream_class *stream_class); | |
594a3fb7 | 65 | |
44c440bc PP |
66 | extern int bt_stream_class_set_assigns_automatic_event_class_id( |
67 | struct bt_stream_class *stream_class, bt_bool value); | |
594a3fb7 | 68 | |
44c440bc PP |
69 | extern bt_bool bt_stream_class_assigns_automatic_stream_id( |
70 | struct bt_stream_class *stream_class); | |
2f100782 | 71 | |
44c440bc PP |
72 | extern int bt_stream_class_set_assigns_automatic_stream_id( |
73 | struct bt_stream_class *stream_class, bt_bool value); | |
adc315b8 | 74 | |
44c440bc | 75 | extern uint64_t bt_stream_class_get_id(struct bt_stream_class *stream_class); |
69dc4535 | 76 | |
094ff7c0 PP |
77 | extern struct bt_field_type *bt_stream_class_borrow_packet_context_field_type( |
78 | struct bt_stream_class *stream_class); | |
79 | ||
3dca2276 | 80 | extern int bt_stream_class_set_packet_context_field_type( |
50842bdc | 81 | struct bt_stream_class *stream_class, |
44c440bc | 82 | struct bt_field_type *field_type); |
12c8a1a3 | 83 | |
094ff7c0 PP |
84 | extern struct bt_field_type * |
85 | bt_stream_class_borrow_event_header_field_type( | |
86 | struct bt_stream_class *stream_class); | |
87 | ||
3dca2276 | 88 | extern int bt_stream_class_set_event_header_field_type( |
50842bdc | 89 | struct bt_stream_class *stream_class, |
44c440bc | 90 | struct bt_field_type *field_type); |
312c056a | 91 | |
094ff7c0 | 92 | extern struct bt_field_type * |
44c440bc | 93 | bt_stream_class_borrow_event_common_context_field_type( |
094ff7c0 PP |
94 | struct bt_stream_class *stream_class); |
95 | ||
44c440bc | 96 | extern int bt_stream_class_set_event_common_context_field_type( |
50842bdc | 97 | struct bt_stream_class *stream_class, |
44c440bc | 98 | struct bt_field_type *field_type); |
594a3fb7 | 99 | |
44c440bc | 100 | extern uint64_t bt_stream_class_get_event_class_count( |
50842bdc | 101 | struct bt_stream_class *stream_class); |
594a3fb7 | 102 | |
094ff7c0 PP |
103 | extern struct bt_event_class *bt_stream_class_borrow_event_class_by_index( |
104 | struct bt_stream_class *stream_class, uint64_t index); | |
105 | ||
094ff7c0 PP |
106 | extern struct bt_event_class *bt_stream_class_borrow_event_class_by_id( |
107 | struct bt_stream_class *stream_class, uint64_t id); | |
594a3fb7 | 108 | |
44c440bc | 109 | extern int bt_stream_class_set_default_clock_class( |
50842bdc | 110 | struct bt_stream_class *stream_class, |
44c440bc PP |
111 | struct bt_clock_class *clock_class); |
112 | ||
113 | extern struct bt_clock_class *bt_stream_class_borrow_default_clock_class( | |
114 | struct bt_stream_class *stream_class); | |
594a3fb7 | 115 | |
44c440bc PP |
116 | extern bt_bool bt_stream_class_default_clock_is_always_known( |
117 | struct bt_stream_class *stream_class); | |
594a3fb7 | 118 | |
44c440bc PP |
119 | extern bt_bool bt_stream_class_packets_have_discarded_event_counter_snapshot( |
120 | struct bt_stream_class *stream_class); | |
594a3fb7 | 121 | |
44c440bc PP |
122 | extern int bt_stream_class_set_packets_have_discarded_event_counter_snapshot( |
123 | struct bt_stream_class *stream_class, bt_bool value); | |
594a3fb7 | 124 | |
44c440bc PP |
125 | extern bt_bool bt_stream_class_packets_have_packet_counter_snapshot( |
126 | struct bt_stream_class *stream_class); | |
594a3fb7 | 127 | |
44c440bc PP |
128 | extern int bt_stream_class_set_packets_have_packet_counter_snapshot( |
129 | struct bt_stream_class *stream_class, bt_bool value); | |
594a3fb7 | 130 | |
44c440bc PP |
131 | extern bt_bool bt_stream_class_packets_have_default_beginning_clock_value( |
132 | struct bt_stream_class *stream_class); | |
594a3fb7 | 133 | |
44c440bc PP |
134 | extern int bt_stream_class_set_packets_have_default_beginning_clock_value( |
135 | struct bt_stream_class *stream_class, bt_bool value); | |
8bf65fbd | 136 | |
44c440bc PP |
137 | extern bt_bool bt_stream_class_packets_have_default_end_clock_value( |
138 | struct bt_stream_class *stream_class); | |
594a3fb7 | 139 | |
44c440bc PP |
140 | extern int bt_stream_class_set_packets_have_default_end_clock_value( |
141 | struct bt_stream_class *stream_class, bt_bool value); | |
594a3fb7 | 142 | |
adc315b8 JG |
143 | #ifdef __cplusplus |
144 | } | |
145 | #endif | |
146 | ||
147 | #endif /* BABELTRACE_CTF_IR_STREAM_CLASS_H */ |