lib: Reset libbabeltrace2 to SONANE 0
[babeltrace.git] / include / babeltrace / trace-ir / stream-class-const.h
CommitLineData
40f4ba76
PP
1#ifndef BABELTRACE_TRACE_IR_STREAM_CLASS_CONST_H
2#define BABELTRACE_TRACE_IR_STREAM_CLASS_CONST_H
3
4/*
e2f7325d 5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
40f4ba76
PP
6 * Copyright 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 *
40f4ba76
PP
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
b19ff26f
PP
32/*
33 * For bt_bool, bt_trace_class, bt_stream_class, bt_event_class,
83ebb7f1 34 * bt_stream_class
b19ff26f 35 */
40f4ba76
PP
36#include <babeltrace/types.h>
37
38#ifdef __cplusplus
39extern "C" {
40#endif
41
4cdfc5e8 42typedef enum bt_stream_class_status {
a6ae8edc
PP
43 BT_STREAM_CLASS_STATUS_OK = 0,
44 BT_STREAM_CLASS_STATUS_NOMEM = -12,
4cdfc5e8 45} bt_stream_class_status;
a6ae8edc 46
b19ff26f
PP
47extern const bt_trace_class *bt_stream_class_borrow_trace_class_const(
48 const bt_stream_class *stream_class);
40f4ba76
PP
49
50extern const char *bt_stream_class_get_name(
b19ff26f 51 const bt_stream_class *stream_class);
40f4ba76
PP
52
53extern bt_bool bt_stream_class_assigns_automatic_event_class_id(
b19ff26f 54 const bt_stream_class *stream_class);
40f4ba76
PP
55
56extern bt_bool bt_stream_class_assigns_automatic_stream_id(
b19ff26f 57 const bt_stream_class *stream_class);
40f4ba76 58
9b24b6aa 59extern bt_bool bt_stream_class_packets_have_beginning_default_clock_snapshot(
649934d2
PP
60 const bt_stream_class *stream_class);
61
9b24b6aa 62extern bt_bool bt_stream_class_packets_have_end_default_clock_snapshot(
649934d2
PP
63 const bt_stream_class *stream_class);
64
2e90378a
PP
65extern bt_bool bt_stream_class_supports_discarded_events(
66 const bt_stream_class *stream_class);
67
68extern bt_bool bt_stream_class_supports_discarded_packets(
69 const bt_stream_class *stream_class);
70
71extern bt_bool bt_stream_class_discarded_events_have_default_clock_snapshots(
72 const bt_stream_class *stream_class);
73
74extern bt_bool bt_stream_class_discarded_packets_have_default_clock_snapshots(
75 const bt_stream_class *stream_class);
76
40f4ba76 77extern uint64_t bt_stream_class_get_id(
b19ff26f 78 const bt_stream_class *stream_class);
40f4ba76 79
b19ff26f 80extern const bt_field_class *
40f4ba76 81bt_stream_class_borrow_packet_context_field_class_const(
b19ff26f 82 const bt_stream_class *stream_class);
40f4ba76 83
b19ff26f 84extern const bt_field_class *
40f4ba76 85bt_stream_class_borrow_event_common_context_field_class_const(
b19ff26f 86 const bt_stream_class *stream_class);
40f4ba76
PP
87
88extern uint64_t bt_stream_class_get_event_class_count(
b19ff26f 89 const bt_stream_class *stream_class);
40f4ba76 90
b19ff26f 91extern const bt_event_class *
40f4ba76 92bt_stream_class_borrow_event_class_by_index_const(
b19ff26f 93 const bt_stream_class *stream_class, uint64_t index);
40f4ba76 94
b19ff26f 95extern const bt_event_class *
40f4ba76 96bt_stream_class_borrow_event_class_by_id_const(
b19ff26f 97 const bt_stream_class *stream_class, uint64_t id);
40f4ba76 98
b19ff26f 99extern const bt_clock_class *
40f4ba76 100bt_stream_class_borrow_default_clock_class_const(
b19ff26f 101 const bt_stream_class *stream_class);
40f4ba76 102
b19ff26f 103extern void bt_stream_class_get_ref(const bt_stream_class *stream_class);
c5b9b441 104
b19ff26f 105extern void bt_stream_class_put_ref(const bt_stream_class *stream_class);
c5b9b441
PP
106
107#define BT_STREAM_CLASS_PUT_REF_AND_RESET(_var) \
108 do { \
109 bt_stream_class_put_ref(_var); \
110 (_var) = NULL; \
111 } while (0)
112
113#define BT_STREAM_CLASS_MOVE_REF(_var_dst, _var_src) \
114 do { \
115 bt_stream_class_put_ref(_var_dst); \
116 (_var_dst) = (_var_src); \
117 (_var_src) = NULL; \
118 } while (0)
119
40f4ba76
PP
120#ifdef __cplusplus
121}
122#endif
123
124#endif /* BABELTRACE_TRACE_IR_STREAM_CLASS_CONST_H */
This page took 0.035485 seconds and 4 git commands to generate.