lib: standardize public include guards
[babeltrace.git] / include / babeltrace2 / ctf-writer / stream.h
1 #ifndef BABELTRACE2_CTF_WRITER_STREAM_H
2 #define BABELTRACE2_CTF_WRITER_STREAM_H
3
4 /*
5 * Copyright 2013, 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 #include <stdint.h>
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 struct bt_ctf_stream;
38 struct bt_ctf_event;
39
40 /*
41 * bt_ctf_stream_get_discarded_events_count: get the number of discarded
42 * events associated with this stream.
43 *
44 * Note that discarded events are not stored if the stream's packet
45 * context has no "events_discarded" field. An error will be returned
46 * in that case.
47 *
48 * @param stream Stream instance.
49 *
50 * Returns the number of discarded events, a negative value on error.
51 */
52 extern int bt_ctf_stream_get_discarded_events_count(
53 struct bt_ctf_stream *stream, uint64_t *count);
54
55 /*
56 * bt_ctf_stream_append_discarded_events: increment discarded events count.
57 *
58 * Increase the current packet's discarded event count. Has no effect if the
59 * stream class' packet context has no "events_discarded" field.
60 *
61 * @param stream Stream instance.
62 * @param event_count Number of discarded events to add to the stream's current
63 * packet.
64 */
65 extern void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream *stream,
66 uint64_t event_count);
67
68 /*
69 * bt_ctf_stream_append_event: append an event to the stream.
70 *
71 * Append "event" to the stream's current packet. The stream's associated clock
72 * will be sampled during this call. The event shall not be modified after
73 * being appended to a stream. The stream will share the event's ownership by
74 * incrementing its reference count. The current packet is not flushed to disk
75 * until the next call to bt_ctf_stream_flush.
76 *
77 * The stream event context will be sampled for every appended event if
78 * a stream event context was defined.
79 *
80 * @param stream Stream instance.
81 * @param event Event instance to append to the stream's current packet.
82 *
83 * Returns 0 on success, a negative value on error.
84 */
85 extern int bt_ctf_stream_append_event(struct bt_ctf_stream *stream,
86 struct bt_ctf_event *event);
87
88 /*
89 * bt_ctf_stream_get_packet_header: get a stream's packet header.
90 *
91 * @param stream Stream instance.
92 *
93 * Returns a field instance on success, NULL on error.
94 */
95 extern struct bt_ctf_field *bt_ctf_stream_get_packet_header(
96 struct bt_ctf_stream *stream);
97
98 /*
99 * bt_ctf_stream_set_packet_header: set a stream's packet header.
100 *
101 * The packet header's type must match the trace's packet header
102 * type.
103 *
104 * @param stream Stream instance.
105 * @param packet_header Packet header instance.
106 *
107 * Returns a field instance on success, NULL on error.
108 */
109 extern int bt_ctf_stream_set_packet_header(
110 struct bt_ctf_stream *stream,
111 struct bt_ctf_field *packet_header);
112
113 /*
114 * bt_ctf_stream_get_packet_context: get a stream's packet context.
115 *
116 * @param stream Stream instance.
117 *
118 * Returns a field instance on success, NULL on error.
119 */
120 extern struct bt_ctf_field *bt_ctf_stream_get_packet_context(
121 struct bt_ctf_stream *stream);
122
123 /*
124 * bt_ctf_stream_set_packet_context: set a stream's packet context.
125 *
126 * The packet context's type must match the stream class' packet
127 * context type.
128 *
129 * @param stream Stream instance.
130 * @param packet_context Packet context field instance.
131 *
132 * Returns a field instance on success, NULL on error.
133 */
134 extern int bt_ctf_stream_set_packet_context(
135 struct bt_ctf_stream *stream,
136 struct bt_ctf_field *packet_context);
137
138 /*
139 * bt_ctf_stream_flush: flush a stream.
140 *
141 * The stream's current packet's events will be flushed, thus closing the
142 * current packet. Events subsequently appended to the stream will be
143 * added to a new packet.
144 *
145 * Flushing will also set the packet context's default attributes if
146 * they remained unset while populating the current packet. These default
147 * attributes, along with their expected types, are detailed in stream-class.h.
148 *
149 * @param stream Stream instance.
150 *
151 * Returns 0 on success, a negative value on error.
152 */
153 extern int bt_ctf_stream_flush(struct bt_ctf_stream *stream);
154
155 extern int bt_ctf_stream_is_writer(struct bt_ctf_stream *stream);
156
157 extern
158 struct bt_ctf_stream *bt_ctf_stream_create(
159 struct bt_ctf_stream_class *stream_class,
160 const char *name, uint64_t id);
161
162 extern struct bt_ctf_stream_class *bt_ctf_stream_get_class(
163 struct bt_ctf_stream *stream);
164
165 extern const char *bt_ctf_stream_get_name(struct bt_ctf_stream *stream);
166
167 extern int64_t bt_ctf_stream_get_id(struct bt_ctf_stream *stream);
168
169 /* Pre-2.0 CTF writer compatibility */
170 static inline
171 void bt_ctf_stream_get(struct bt_ctf_stream *stream)
172 {
173 bt_ctf_object_get_ref(stream);
174 }
175
176 /* Pre-2.0 CTF writer compatibility */
177 static inline
178 void bt_ctf_stream_put(struct bt_ctf_stream *stream)
179 {
180 bt_ctf_object_put_ref(stream);
181 }
182
183 #ifdef __cplusplus
184 }
185 #endif
186
187 #endif /* BABELTRACE2_CTF_WRITER_STREAM_H */
This page took 0.033402 seconds and 4 git commands to generate.