lib: standardize public include guards
[babeltrace.git] / include / babeltrace2 / ctf-writer / stream-class.h
CommitLineData
924dc299
PP
1#ifndef BABELTRACE2_CTF_WRITER_STREAM_CLASS_H
2#define BABELTRACE2_CTF_WRITER_STREAM_CLASS_H
8c18d80b 3
cf6f1e34 4/*
cf6f1e34
JG
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
3fadfbc0 31#include <babeltrace2/ctf-writer/object.h>
8c18d80b
PP
32
33#ifdef __cplusplus
34extern "C" {
35#endif
36
3dca2276
PP
37struct bt_ctf_stream_class;
38struct bt_ctf_trace;
39struct bt_ctf_event_class;
40struct bt_ctf_field_type;
41struct bt_ctf_clock;
42
43extern struct bt_ctf_stream_class *bt_ctf_stream_class_create(
44 const char *name);
45
46extern struct bt_ctf_trace *bt_ctf_stream_class_get_trace(
47 struct bt_ctf_stream_class *stream_class);
48
49extern const char *bt_ctf_stream_class_get_name(
50 struct bt_ctf_stream_class *stream_class);
51
52extern int bt_ctf_stream_class_set_name(
53 struct bt_ctf_stream_class *stream_class, const char *name);
54
55extern int64_t bt_ctf_stream_class_get_id(
56 struct bt_ctf_stream_class *stream_class);
57
58extern int bt_ctf_stream_class_set_id(
59 struct bt_ctf_stream_class *stream_class, uint64_t id);
60
61extern struct bt_ctf_field_type *bt_ctf_stream_class_get_packet_context_type(
62 struct bt_ctf_stream_class *stream_class);
63
64extern int bt_ctf_stream_class_set_packet_context_type(
65 struct bt_ctf_stream_class *stream_class,
66 struct bt_ctf_field_type *packet_context_type);
67
68extern struct bt_ctf_field_type *
69bt_ctf_stream_class_get_event_header_type(
70 struct bt_ctf_stream_class *stream_class);
71
72extern int bt_ctf_stream_class_set_event_header_type(
73 struct bt_ctf_stream_class *stream_class,
74 struct bt_ctf_field_type *event_header_type);
75
76extern struct bt_ctf_field_type *
77bt_ctf_stream_class_get_event_context_type(
78 struct bt_ctf_stream_class *stream_class);
79
80extern int bt_ctf_stream_class_set_event_context_type(
81 struct bt_ctf_stream_class *stream_class,
82 struct bt_ctf_field_type *event_context_type);
83
84extern int64_t bt_ctf_stream_class_get_event_class_count(
85 struct bt_ctf_stream_class *stream_class);
86
87extern struct bt_ctf_event_class *bt_ctf_stream_class_get_event_class_by_index(
88 struct bt_ctf_stream_class *stream_class, uint64_t index);
89
90extern struct bt_ctf_event_class *bt_ctf_stream_class_get_event_class_by_id(
91 struct bt_ctf_stream_class *stream_class, uint64_t id);
92
93extern int bt_ctf_stream_class_add_event_class(
94 struct bt_ctf_stream_class *stream_class,
95 struct bt_ctf_event_class *event_class);
96
97extern int bt_ctf_stream_class_set_clock(
98 struct bt_ctf_stream_class *ctf_stream_class,
72bd645e
PP
99 struct bt_ctf_clock *clock);
100
3dca2276
PP
101extern struct bt_ctf_clock *bt_ctf_stream_class_get_clock(
102 struct bt_ctf_stream_class *stream_class);
50842bdc
PP
103
104/* Pre-2.0 CTF writer compatibility */
3dca2276
PP
105static inline
106void bt_ctf_stream_class_get(struct bt_ctf_stream_class *stream_class)
107{
e1e02a22 108 bt_ctf_object_get_ref(stream_class);
3dca2276 109}
ac0c6bdd 110
3dca2276
PP
111/* Pre-2.0 CTF writer compatibility */
112static inline
113void bt_ctf_stream_class_put(struct bt_ctf_stream_class *stream_class)
114{
e1e02a22 115 bt_ctf_object_put_ref(stream_class);
3dca2276 116}
8c18d80b
PP
117
118#ifdef __cplusplus
119}
120#endif
121
924dc299 122#endif /* BABELTRACE2_CTF_WRITER_STREAM_CLASS_H */
This page took 0.060361 seconds and 4 git commands to generate.