56b6bff8c29edb10bd5e1da77050d4345d6c506f
1 #ifndef BABELTRACE_CTF_WRITER_STREAM_H
2 #define BABELTRACE_CTF_WRITER_STREAM_H
5 * BabelTrace - CTF Writer: Stream
7 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
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:
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
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
29 * The Common Trace Format (CTF) Specification is available at
30 * http://www.efficios.com/ctf
33 #include <babeltrace/ctf-ir/stream.h>
34 #include <babeltrace/ctf-writer/stream-class.h>
41 * bt_ctf_stream_get_discarded_events_count: get the number of discarded
42 * events associated with this stream.
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
48 * @param stream Stream instance.
50 * Returns the number of discarded events, a negative value on error.
52 extern int bt_ctf_stream_get_discarded_events_count(
53 struct bt_ctf_stream
*stream
, uint64_t *count
);
56 * bt_ctf_stream_append_discarded_events: increment discarded events count.
58 * Increase the current packet's discarded event count. Has no effect if the
59 * stream class' packet context has no "events_discarded" field.
61 * @param stream Stream instance.
62 * @param event_count Number of discarded events to add to the stream's current
65 extern void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream
*stream
,
66 uint64_t event_count
);
69 * bt_ctf_stream_append_event: append an event to the stream.
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.
77 * The stream event context will be sampled for every appended event if
78 * a stream event context was defined.
80 * @param stream Stream instance.
81 * @param event Event instance to append to the stream's current packet.
83 * Returns 0 on success, a negative value on error.
85 extern int bt_ctf_stream_append_event(struct bt_ctf_stream
*stream
,
86 struct bt_ctf_event
*event
);
89 * bt_ctf_stream_get_packet_header: get a stream's packet header.
91 * @param stream Stream instance.
93 * Returns a field instance on success, NULL on error.
95 extern struct bt_ctf_field
*bt_ctf_stream_get_packet_header(
96 struct bt_ctf_stream
*stream
);
99 * bt_ctf_stream_set_packet_header: set a stream's packet header.
101 * The packet header's type must match the trace's packet header
104 * @param stream Stream instance.
105 * @param packet_header Packet header instance.
107 * Returns a field instance on success, NULL on error.
109 extern int bt_ctf_stream_set_packet_header(
110 struct bt_ctf_stream
*stream
,
111 struct bt_ctf_field
*packet_header
);
114 * bt_ctf_stream_get_packet_context: get a stream's packet context.
116 * @param stream Stream instance.
118 * Returns a field instance on success, NULL on error.
120 extern struct bt_ctf_field
*bt_ctf_stream_get_packet_context(
121 struct bt_ctf_stream
*stream
);
124 * bt_ctf_stream_set_packet_context: set a stream's packet context.
126 * The packet context's type must match the stream class' packet
129 * @param stream Stream instance.
130 * @param packet_context Packet context field instance.
132 * Returns a field instance on success, NULL on error.
134 extern int bt_ctf_stream_set_packet_context(
135 struct bt_ctf_stream
*stream
,
136 struct bt_ctf_field
*packet_context
);
139 * bt_ctf_stream_flush: flush a stream.
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.
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.
149 * @param stream Stream instance.
151 * Returns 0 on success, a negative value on error.
153 extern int bt_ctf_stream_flush(struct bt_ctf_stream
*stream
);
155 extern int bt_ctf_stream_is_writer(struct bt_ctf_stream
*stream
);
158 * bt_ctf_stream_get and bt_ctf_stream_put: increment and decrement the
159 * stream's reference count.
161 * You may also use bt_ctf_get() and bt_ctf_put() with stream objects.
163 * These functions ensure that the stream won't be destroyed while it
164 * is in use. The same number of get and put (plus one extra put to
165 * release the initial reference done at creation) have to be done to
168 * When the stream's reference count is decremented to 0 by a
169 * bt_ctf_stream_put, the stream is freed.
171 * @param stream Stream instance.
173 extern void bt_ctf_stream_get(struct bt_ctf_stream
*stream
);
174 extern void bt_ctf_stream_put(struct bt_ctf_stream
*stream
);
180 #endif /* BABELTRACE_CTF_WRITER_STREAM_H */
This page took 0.032372 seconds and 4 git commands to generate.