lib: make values API const-correct
[babeltrace.git] / include / babeltrace / trace-ir / private-trace.h
CommitLineData
e5be10ef
PP
1#ifndef BABELTRACE_TRACE_IR_PRIVATE_TRACE_H
2#define BABELTRACE_TRACE_IR_PRIVATE_TRACE_H
3
4/*
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/* For bt_bool, bt_uuid */
32#include <babeltrace/types.h>
33
34#include <stdint.h>
35
36#ifdef __cplusplus
37extern "C" {
38#endif
39
40struct bt_trace;
41struct bt_private_trace;
42struct bt_private_stream;
43struct bt_private_stream_class;
44struct bt_private_field_class;
05e21286 45struct bt_value;
e5be10ef
PP
46struct bt_private_packet_header_field;
47
48typedef void (* bt_private_trace_is_static_listener)(
49 struct bt_private_trace *trace, void *data);
50
51typedef void (* bt_private_trace_listener_removed)(
52 struct bt_private_trace *trace, void *data);
53
d94d92ac 54static inline
707b7d35 55struct bt_trace *bt_private_trace_as_trace(
d94d92ac
PP
56 struct bt_private_trace *priv_trace)
57{
58 return (void *) priv_trace;
59}
e5be10ef
PP
60
61extern struct bt_private_trace *bt_private_trace_create(void);
62
140e6d94 63extern void bt_private_trace_set_assigns_automatic_stream_class_id(
e5be10ef
PP
64 struct bt_private_trace *trace, bt_bool value);
65
66extern int bt_private_trace_set_name(struct bt_private_trace *trace,
67 const char *name);
68
140e6d94 69extern void bt_private_trace_set_uuid(struct bt_private_trace *trace,
e5be10ef
PP
70 bt_uuid uuid);
71
28e6ca8b 72extern void bt_private_trace_borrow_environment_entry_by_index(
e5be10ef 73 struct bt_private_trace *trace, uint64_t index,
05e21286 74 const char **name, const struct bt_value **value);
e5be10ef 75
05e21286 76extern const struct bt_value *
28e6ca8b 77bt_private_trace_borrow_environment_entry_value_by_name(
e5be10ef
PP
78 struct bt_private_trace *trace, const char *name);
79
28e6ca8b 80extern int bt_private_trace_set_environment_entry_integer(
e5be10ef
PP
81 struct bt_private_trace *trace, const char *name,
82 int64_t value);
83
28e6ca8b 84extern int bt_private_trace_set_environment_entry_string(
e5be10ef
PP
85 struct bt_private_trace *trace, const char *name,
86 const char *value);
87
88extern struct bt_private_field_class *
28e6ca8b 89bt_private_trace_borrow_packet_header_field_class(
e5be10ef
PP
90 struct bt_private_trace *trace);
91
28e6ca8b 92extern int bt_private_trace_set_packet_header_field_class(
e5be10ef
PP
93 struct bt_private_trace *trace,
94 struct bt_private_field_class *packet_header_field_class);
95
96extern struct bt_private_stream_class *
28e6ca8b 97bt_private_trace_borrow_stream_class_by_index(
e5be10ef
PP
98 struct bt_private_trace *trace, uint64_t index);
99
100extern struct bt_private_stream_class *
28e6ca8b 101bt_private_trace_borrow_stream_class_by_id(
e5be10ef
PP
102 struct bt_private_trace *trace, uint64_t id);
103
104extern struct bt_private_stream *
28e6ca8b 105bt_private_trace_borrow_stream_by_index(
e5be10ef
PP
106 struct bt_private_trace *trace, uint64_t index);
107
108extern struct bt_private_stream *bt_private_trace_borrow_stream_by_id(
109 struct bt_private_trace *trace, uint64_t id);
110
111extern int bt_private_trace_make_static(struct bt_private_trace *trace);
112
113extern int bt_private_trace_add_is_static_listener(
114 struct bt_private_trace *trace,
115 bt_private_trace_is_static_listener listener,
116 bt_private_trace_listener_removed listener_removed, void *data,
117 uint64_t *listener_id);
118
119extern int bt_private_trace_remove_is_static_listener(
120 struct bt_private_trace *trace, uint64_t listener_id);
121
122#ifdef __cplusplus
123}
124#endif
125
126#endif /* BABELTRACE_TRACE_IR_PRIVATE_TRACE_H */
This page took 0.035406 seconds and 4 git commands to generate.