lib: force user to include `<babeltrace2/babeltrace.h>`
[babeltrace.git] / include / babeltrace2 / trace-ir / stream-class-const.h
... / ...
CommitLineData
1#ifndef BABELTRACE2_TRACE_IR_STREAM_CLASS_CONST_H
2#define BABELTRACE2_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#ifndef __BT_IN_BABELTRACE_H
31# error "Please include <babeltrace2/babeltrace.h> instead."
32#endif
33
34#include <stdint.h>
35
36/*
37 * For bt_bool, bt_trace_class, bt_stream_class, bt_event_class,
38 * bt_stream_class
39 */
40#include <babeltrace2/types.h>
41
42#ifdef __cplusplus
43extern "C" {
44#endif
45
46extern const bt_trace_class *bt_stream_class_borrow_trace_class_const(
47 const bt_stream_class *stream_class);
48
49extern const char *bt_stream_class_get_name(
50 const bt_stream_class *stream_class);
51
52extern bt_bool bt_stream_class_assigns_automatic_event_class_id(
53 const bt_stream_class *stream_class);
54
55extern bt_bool bt_stream_class_assigns_automatic_stream_id(
56 const bt_stream_class *stream_class);
57
58extern bt_bool bt_stream_class_supports_packets(
59 const bt_stream_class *stream_class);
60
61extern bt_bool bt_stream_class_packets_have_beginning_default_clock_snapshot(
62 const bt_stream_class *stream_class);
63
64extern bt_bool bt_stream_class_packets_have_end_default_clock_snapshot(
65 const bt_stream_class *stream_class);
66
67extern bt_bool bt_stream_class_supports_discarded_events(
68 const bt_stream_class *stream_class);
69
70extern bt_bool bt_stream_class_supports_discarded_packets(
71 const bt_stream_class *stream_class);
72
73extern bt_bool bt_stream_class_discarded_events_have_default_clock_snapshots(
74 const bt_stream_class *stream_class);
75
76extern bt_bool bt_stream_class_discarded_packets_have_default_clock_snapshots(
77 const bt_stream_class *stream_class);
78
79extern uint64_t bt_stream_class_get_id(
80 const bt_stream_class *stream_class);
81
82extern const bt_field_class *
83bt_stream_class_borrow_packet_context_field_class_const(
84 const bt_stream_class *stream_class);
85
86extern const bt_field_class *
87bt_stream_class_borrow_event_common_context_field_class_const(
88 const bt_stream_class *stream_class);
89
90extern uint64_t bt_stream_class_get_event_class_count(
91 const bt_stream_class *stream_class);
92
93extern const bt_event_class *
94bt_stream_class_borrow_event_class_by_index_const(
95 const bt_stream_class *stream_class, uint64_t index);
96
97extern const bt_event_class *
98bt_stream_class_borrow_event_class_by_id_const(
99 const bt_stream_class *stream_class, uint64_t id);
100
101extern const bt_clock_class *
102bt_stream_class_borrow_default_clock_class_const(
103 const bt_stream_class *stream_class);
104
105extern void bt_stream_class_get_ref(const bt_stream_class *stream_class);
106
107extern void bt_stream_class_put_ref(const bt_stream_class *stream_class);
108
109#define BT_STREAM_CLASS_PUT_REF_AND_RESET(_var) \
110 do { \
111 bt_stream_class_put_ref(_var); \
112 (_var) = NULL; \
113 } while (0)
114
115#define BT_STREAM_CLASS_MOVE_REF(_var_dst, _var_src) \
116 do { \
117 bt_stream_class_put_ref(_var_dst); \
118 (_var_dst) = (_var_src); \
119 (_var_src) = NULL; \
120 } while (0)
121
122#ifdef __cplusplus
123}
124#endif
125
126#endif /* BABELTRACE2_TRACE_IR_STREAM_CLASS_CONST_H */
This page took 0.027918 seconds and 4 git commands to generate.