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