1 #ifndef BABELTRACE_TRACE_IR_STREAM_CLASS_H
2 #define BABELTRACE_TRACE_IR_STREAM_CLASS_H
5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
6 * Copyright 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26 * The Common Trace Format (CTF) Specification is available at
27 * http://www.efficios.com/ctf
33 * For bt_bool, bt_trace_class, bt_stream_class, bt_event_class,
36 #include <babeltrace2/types.h>
38 /* For bt_stream_class_status */
39 #include <babeltrace2/trace-ir/stream-class-const.h>
45 extern bt_stream_class
*bt_stream_class_create(
46 bt_trace_class
*trace_class
);
48 extern bt_stream_class
*bt_stream_class_create_with_id(
49 bt_trace_class
*trace_class
, uint64_t id
);
51 extern bt_trace_class
*bt_stream_class_borrow_trace_class(
52 bt_stream_class
*stream_class
);
54 extern bt_stream_class_status
bt_stream_class_set_name(
55 bt_stream_class
*stream_class
, const char *name
);
57 extern void bt_stream_class_set_assigns_automatic_event_class_id(
58 bt_stream_class
*stream_class
, bt_bool value
);
60 extern void bt_stream_class_set_assigns_automatic_stream_id(
61 bt_stream_class
*stream_class
, bt_bool value
);
63 extern void bt_stream_class_set_packets_have_beginning_default_clock_snapshot(
64 bt_stream_class
*stream_class
, bt_bool value
);
66 extern void bt_stream_class_set_packets_have_end_default_clock_snapshot(
67 bt_stream_class
*stream_class
, bt_bool value
);
69 extern void bt_stream_class_set_supports_discarded_events(
70 bt_stream_class
*stream_class
,
71 bt_bool supports_discarded_events
,
72 bt_bool with_default_clock_snapshots
);
74 extern void bt_stream_class_set_supports_discarded_packets(
75 bt_stream_class
*stream_class
,
76 bt_bool supports_discarded_packets
,
77 bt_bool with_default_clock_snapshots
);
79 extern bt_stream_class_status
80 bt_stream_class_set_packet_context_field_class(
81 bt_stream_class
*stream_class
,
82 bt_field_class
*field_class
);
84 extern bt_field_class
*
85 bt_stream_class_borrow_packet_context_field_class(
86 bt_stream_class
*stream_class
);
88 extern bt_stream_class_status
89 bt_stream_class_set_event_common_context_field_class(
90 bt_stream_class
*stream_class
,
91 bt_field_class
*field_class
);
93 extern bt_field_class
*
94 bt_stream_class_borrow_event_common_context_field_class(
95 bt_stream_class
*stream_class
);
97 extern bt_event_class
*
98 bt_stream_class_borrow_event_class_by_index(
99 bt_stream_class
*stream_class
, uint64_t index
);
101 extern bt_event_class
*
102 bt_stream_class_borrow_event_class_by_id(
103 bt_stream_class
*stream_class
, uint64_t id
);
105 extern bt_clock_class
*bt_stream_class_borrow_default_clock_class(
106 bt_stream_class
*stream_class
);
108 extern bt_stream_class_status
bt_stream_class_set_default_clock_class(
109 bt_stream_class
*stream_class
,
110 bt_clock_class
*clock_class
);
116 #endif /* BABELTRACE_TRACE_IR_STREAM_CLASS_H */