Values API: split into private and public APIs
[babeltrace.git] / include / babeltrace / ctf-writer / trace.h
CommitLineData
3dca2276
PP
1#ifndef BABELTRACE_CTF_WRITER_TRACE_H
2#define BABELTRACE_CTF_WRITER_TRACE_H
3
4/*
5 * BabelTrace - CTF Writer: Stream Class
6 *
7 * Copyright 2014 EfficiOS Inc.
8 *
9 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
10 *
11 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
17 *
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
20 *
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27 * SOFTWARE.
28 *
29 * The Common Trace Format (CTF) Specification is available at
30 * http://www.efficios.com/ctf
31 */
32
33#ifdef __cplusplus
34extern "C" {
35#endif
36
37struct bt_ctf_trace;
38struct bt_ctf_stream_class;
39struct bt_ctf_stream;
3dca2276
PP
40
41extern enum bt_ctf_byte_order bt_ctf_trace_get_native_byte_order(
42 struct bt_ctf_trace *trace);
43
44extern int bt_ctf_trace_set_native_byte_order(struct bt_ctf_trace *trace,
45 enum bt_ctf_byte_order native_byte_order);
46
47extern const unsigned char *bt_ctf_trace_get_uuid(
48 struct bt_ctf_trace *trace);
49
50extern int bt_ctf_trace_set_uuid(struct bt_ctf_trace *trace,
51 const unsigned char *uuid);
52
53extern int64_t bt_ctf_trace_get_environment_field_count(
54 struct bt_ctf_trace *trace);
55
56extern const char *
57bt_ctf_trace_get_environment_field_name_by_index(
58 struct bt_ctf_trace *trace, uint64_t index);
59
60extern struct bt_value *
61bt_ctf_trace_get_environment_field_value_by_index(struct bt_ctf_trace *trace,
62 uint64_t index);
63
64extern struct bt_value *
65bt_ctf_trace_get_environment_field_value_by_name(
66 struct bt_ctf_trace *trace, const char *name);
67
3dca2276
PP
68extern int bt_ctf_trace_set_environment_field_integer(
69 struct bt_ctf_trace *trace, const char *name,
70 int64_t value);
71
72extern int bt_ctf_trace_set_environment_field_string(
73 struct bt_ctf_trace *trace, const char *name,
74 const char *value);
75
76extern struct bt_ctf_field_type *bt_ctf_trace_get_packet_header_field_type(
77 struct bt_ctf_trace *trace);
78
79extern int bt_ctf_trace_set_packet_header_field_type(struct bt_ctf_trace *trace,
80 struct bt_ctf_field_type *packet_header_type);
81
3dca2276
PP
82extern int64_t bt_ctf_trace_get_stream_class_count(
83 struct bt_ctf_trace *trace);
84
85extern struct bt_ctf_stream_class *bt_ctf_trace_get_stream_class_by_index(
86 struct bt_ctf_trace *trace, uint64_t index);
87
88extern struct bt_ctf_stream_class *bt_ctf_trace_get_stream_class_by_id(
89 struct bt_ctf_trace *trace, uint64_t id);
90
91extern int bt_ctf_trace_add_stream_class(struct bt_ctf_trace *trace,
92 struct bt_ctf_stream_class *stream_class);
93
94extern int64_t bt_ctf_trace_get_stream_count(struct bt_ctf_trace *trace);
95
96extern struct bt_ctf_stream *bt_ctf_trace_get_stream_by_index(
97 struct bt_ctf_trace *trace, uint64_t index);
98
99extern const char *bt_ctf_trace_get_name(struct bt_ctf_trace *trace);
100
101#ifdef __cplusplus
102}
103#endif
104
105#endif /* BABELTRACE_CTF_WRITER_TRACE_H */
This page took 0.026468 seconds and 4 git commands to generate.