lib: standardize public include guards
[babeltrace.git] / include / babeltrace2 / ctf-writer / trace.h
1 #ifndef BABELTRACE2_CTF_WRITER_TRACE_H
2 #define BABELTRACE2_CTF_WRITER_TRACE_H
3
4 /*
5 * Copyright 2014 EfficiOS Inc.
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 #ifdef __cplusplus
32 extern "C" {
33 #endif
34
35 struct bt_ctf_trace;
36 struct bt_ctf_stream_class;
37 struct bt_ctf_stream;
38
39 extern enum bt_ctf_byte_order bt_ctf_trace_get_native_byte_order(
40 struct bt_ctf_trace *trace);
41
42 extern int bt_ctf_trace_set_native_byte_order(struct bt_ctf_trace *trace,
43 enum bt_ctf_byte_order native_byte_order);
44
45 extern const uint8_t *bt_ctf_trace_get_uuid(
46 struct bt_ctf_trace *trace);
47
48 extern int bt_ctf_trace_set_uuid(struct bt_ctf_trace *trace,
49 const uint8_t *uuid);
50
51 extern int bt_ctf_trace_set_environment_field_integer(
52 struct bt_ctf_trace *trace, const char *name,
53 int64_t value);
54
55 extern int bt_ctf_trace_set_environment_field_string(
56 struct bt_ctf_trace *trace, const char *name,
57 const char *value);
58
59 extern struct bt_ctf_field_type *bt_ctf_trace_get_packet_header_field_type(
60 struct bt_ctf_trace *trace);
61
62 extern int bt_ctf_trace_set_packet_header_field_type(struct bt_ctf_trace *trace,
63 struct bt_ctf_field_type *packet_header_type);
64
65 extern int64_t bt_ctf_trace_get_stream_class_count(
66 struct bt_ctf_trace *trace);
67
68 extern struct bt_ctf_stream_class *bt_ctf_trace_get_stream_class_by_index(
69 struct bt_ctf_trace *trace, uint64_t index);
70
71 extern struct bt_ctf_stream_class *bt_ctf_trace_get_stream_class_by_id(
72 struct bt_ctf_trace *trace, uint64_t id);
73
74 extern int bt_ctf_trace_add_stream_class(struct bt_ctf_trace *trace,
75 struct bt_ctf_stream_class *stream_class);
76
77 extern int64_t bt_ctf_trace_get_stream_count(struct bt_ctf_trace *trace);
78
79 extern struct bt_ctf_stream *bt_ctf_trace_get_stream_by_index(
80 struct bt_ctf_trace *trace, uint64_t index);
81
82 extern const char *bt_ctf_trace_get_name(struct bt_ctf_trace *trace);
83
84 #ifdef __cplusplus
85 }
86 #endif
87
88 #endif /* BABELTRACE2_CTF_WRITER_TRACE_H */
This page took 0.030967 seconds and 4 git commands to generate.