Packet API: use status
[babeltrace.git] / include / babeltrace / trace-ir / stream-class-const.h
1 #ifndef BABELTRACE_TRACE_IR_STREAM_CLASS_CONST_H
2 #define BABELTRACE_TRACE_IR_STREAM_CLASS_CONST_H
3
4 /*
5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
6 * Copyright 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 * SOFTWARE.
25 *
26 * The Common Trace Format (CTF) Specification is available at
27 * http://www.efficios.com/ctf
28 */
29
30 #include <stdint.h>
31
32 /*
33 * For bt_bool, bt_trace_class, bt_stream_class, bt_event_class,
34 * bt_stream_class, bt_event_header_field, bt_packet_context_field
35 */
36 #include <babeltrace/types.h>
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41
42 extern const bt_trace_class *bt_stream_class_borrow_trace_class_const(
43 const bt_stream_class *stream_class);
44
45 extern const char *bt_stream_class_get_name(
46 const bt_stream_class *stream_class);
47
48 extern bt_bool bt_stream_class_assigns_automatic_event_class_id(
49 const bt_stream_class *stream_class);
50
51 extern bt_bool bt_stream_class_assigns_automatic_stream_id(
52 const bt_stream_class *stream_class);
53
54 extern uint64_t bt_stream_class_get_id(
55 const bt_stream_class *stream_class);
56
57 extern const bt_field_class *
58 bt_stream_class_borrow_packet_context_field_class_const(
59 const bt_stream_class *stream_class);
60
61 extern const bt_field_class *
62 bt_stream_class_borrow_event_header_field_class_const(
63 const bt_stream_class *stream_class);
64
65 extern const bt_field_class *
66 bt_stream_class_borrow_event_common_context_field_class_const(
67 const bt_stream_class *stream_class);
68
69 extern uint64_t bt_stream_class_get_event_class_count(
70 const bt_stream_class *stream_class);
71
72 extern const bt_event_class *
73 bt_stream_class_borrow_event_class_by_index_const(
74 const bt_stream_class *stream_class, uint64_t index);
75
76 extern const bt_event_class *
77 bt_stream_class_borrow_event_class_by_id_const(
78 const bt_stream_class *stream_class, uint64_t id);
79
80 extern const bt_clock_class *
81 bt_stream_class_borrow_default_clock_class_const(
82 const bt_stream_class *stream_class);
83
84 extern bt_bool bt_stream_class_default_clock_is_always_known(
85 const bt_stream_class *stream_class);
86
87 extern bt_bool bt_stream_class_packets_have_discarded_event_counter_snapshot(
88 const bt_stream_class *stream_class);
89
90 extern bt_bool bt_stream_class_packets_have_packet_counter_snapshot(
91 const bt_stream_class *stream_class);
92
93 extern bt_bool bt_stream_class_packets_have_default_beginning_clock_snapshot(
94 const bt_stream_class *stream_class);
95
96 extern bt_bool bt_stream_class_packets_have_default_end_clock_snapshot(
97 const bt_stream_class *stream_class);
98
99 extern void bt_stream_class_get_ref(const bt_stream_class *stream_class);
100
101 extern void bt_stream_class_put_ref(const bt_stream_class *stream_class);
102
103 #define BT_STREAM_CLASS_PUT_REF_AND_RESET(_var) \
104 do { \
105 bt_stream_class_put_ref(_var); \
106 (_var) = NULL; \
107 } while (0)
108
109 #define BT_STREAM_CLASS_MOVE_REF(_var_dst, _var_src) \
110 do { \
111 bt_stream_class_put_ref(_var_dst); \
112 (_var_dst) = (_var_src); \
113 (_var_src) = NULL; \
114 } while (0)
115
116 #ifdef __cplusplus
117 }
118 #endif
119
120 #endif /* BABELTRACE_TRACE_IR_STREAM_CLASS_CONST_H */
This page took 0.033634 seconds and 4 git commands to generate.