1 #ifndef BABELTRACE_CTF_IR_STREAM_H
2 #define BABELTRACE_CTF_IR_STREAM_H
5 * BabelTrace - CTF IR: 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-class.h>
43 * bt_ctf_stream_get_discarded_events_count: get the number of discarded
44 * events associated with this stream.
46 * @param stream Stream instance.
48 * Returns the number of discarded events, a negative value on error.
50 extern int bt_ctf_stream_get_discarded_events_count(
51 struct bt_ctf_stream
*stream
, uint64_t *count
);
54 * bt_ctf_stream_append_discarded_events: increment discarded events count.
56 * Increase the current packet's discarded event count.
58 * @param stream Stream instance.
59 * @param event_count Number of discarded events to add to the stream's current
62 extern void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream
*stream
,
63 uint64_t event_count
);
66 * bt_ctf_stream_append_event: append an event to the stream.
68 * Append "event" to the stream's current packet. The stream's associated clock
69 * will be sampled during this call. The event shall not be modified after
70 * being appended to a stream. The stream will share the event's ownership by
71 * incrementing its reference count. The current packet is not flushed to disk
72 * until the next call to bt_ctf_stream_flush.
74 * @param stream Stream instance.
75 * @param event Event instance to append to the stream's current packet.
77 * Returns 0 on success, a negative value on error.
79 extern int bt_ctf_stream_append_event(struct bt_ctf_stream
*stream
,
80 struct bt_ctf_event
*event
);
83 * bt_ctf_stream_flush: flush a stream.
85 * The stream's current packet's events will be flushed to disk. Events
86 * subsequently appended to the stream will be added to a new packet.
88 * @param stream Stream instance.
90 * Returns 0 on success, a negative value on error.
92 extern int bt_ctf_stream_flush(struct bt_ctf_stream
*stream
);
95 * bt_ctf_stream_get and bt_ctf_stream_put: increment and decrement the
96 * stream's reference count.
98 * These functions ensure that the stream won't be destroyed while it
99 * is in use. The same number of get and put (plus one extra put to
100 * release the initial reference done at creation) have to be done to
103 * When the stream's reference count is decremented to 0 by a
104 * bt_ctf_stream_put, the stream is freed.
106 * @param stream Stream instance.
108 extern void bt_ctf_stream_get(struct bt_ctf_stream
*stream
);
109 extern void bt_ctf_stream_put(struct bt_ctf_stream
*stream
);
115 #endif /* BABELTRACE_CTF_IR_STREAM_H */
This page took 0.034488 seconds and 4 git commands to generate.