9229f771bcceeb4b75dc4dc8b2ff9aded084aab6
1 #ifndef BABELTRACE_CTF_WRITER_STREAM_H
2 #define BABELTRACE_CTF_WRITER_STREAM_H
5 * BabelTrace - CTF Writer: Stream
7 * Copyright 2013 EfficiOS Inc.
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
38 struct bt_ctf_event_class
;
39 struct bt_ctf_stream_class
;
44 * bt_ctf_stream_class_create: create a stream class.
46 * Allocate a new stream class of the given name. The creation of an event class
47 * sets its reference count to 1.
49 * @param name Stream name.
51 * Returns an allocated stream class on success, NULL on error.
53 extern struct bt_ctf_stream_class
*bt_ctf_stream_class_create(const char *name
);
56 * bt_ctf_stream_class_set_clock: assign a clock to a stream class.
58 * Assign a clock to a stream class. This clock will be sampled each time an
59 * event is appended to an instance of this stream class.
61 * @param stream_class Stream class.
62 * @param clock Clock to assign to the provided stream class.
64 * Returns 0 on success, a negative value on error.
66 extern int bt_ctf_stream_class_set_clock(
67 struct bt_ctf_stream_class
*stream_class
,
68 struct bt_ctf_clock
*clock
);
71 * bt_ctf_stream_class_set_clock: assign a clock to a stream class.
73 * Add an event class to a stream class. New events can be added even after a
74 * stream has beem instanciated and events have been appended. However, a stream
75 * will not accept events of a class that has not been registered beforehand.
76 * The stream class will share the ownership of "event_class" by incrementing
77 * its reference count.
79 * @param stream_class Stream class.
80 * @param event_class Event class to add to the provided stream class.
82 * Returns 0 on success, a negative value on error.
84 extern int bt_ctf_stream_class_add_event_class(
85 struct bt_ctf_stream_class
*stream_class
,
86 struct bt_ctf_event_class
*event_class
);
89 * bt_ctf_stream_class_get and bt_ctf_stream_class_put: increment and
90 * decrement the stream class' reference count.
92 * These functions ensure that the stream class won't be destroyed while it
93 * is in use. The same number of get and put (plus one extra put to
94 * release the initial reference done at creation) have to be done to
95 * destroy a stream class.
97 * When the stream class' reference count is decremented to 0 by a
98 * bt_ctf_stream_class_put, the stream class is freed.
100 * @param stream_class Stream class.
102 extern void bt_ctf_stream_class_get(struct bt_ctf_stream_class
*stream_class
);
103 extern void bt_ctf_stream_class_put(struct bt_ctf_stream_class
*stream_class
);
106 * bt_ctf_stream_append_discarded_events: increment discarded events count.
108 * Increase the current packet's discarded event count.
110 * @param stream Stream instance.
111 * @param event_count Number of discarded events to add to the stream's current
114 * Returns 0 on success, a negative value on error.
116 extern void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream
*stream
,
117 uint64_t event_count
);
120 * bt_ctf_stream_append_event: append an event to the stream.
122 * Append "event" to the stream's current packet. The stream's associated clock
123 * will be sampled during this call. The event shall not be modified after
124 * being appended to a stream. The stream will share the event's ownership by
125 * incrementing its reference count. The current packet is not flushed to disk
126 * until the next call to bt_ctf_stream_flush.
128 * @param stream Stream instance.
129 * @param event Event instance to append to the stream's current packet.
131 * Returns 0 on success, a negative value on error.
133 extern int bt_ctf_stream_append_event(struct bt_ctf_stream
*stream
,
134 struct bt_ctf_event
*event
);
137 * bt_ctf_stream_flush: flush a stream.
139 * The stream's current packet's events will be flushed to disk. Events
140 * subsequently appended to the stream will be added to a new packet.
142 * @param stream Stream instance.
144 * Returns 0 on success, a negative value on error.
146 extern int bt_ctf_stream_flush(struct bt_ctf_stream
*stream
);
149 * bt_ctf_stream_get and bt_ctf_stream_put: increment and decrement the
150 * stream's reference count.
152 * These functions ensure that the stream won't be destroyed while it
153 * is in use. The same number of get and put (plus one extra put to
154 * release the initial reference done at creation) have to be done to
157 * When the stream's reference count is decremented to 0 by a
158 * bt_ctf_stream_put, the stream is freed.
160 * @param stream Stream instance.
162 extern void bt_ctf_stream_get(struct bt_ctf_stream
*stream
);
163 extern void bt_ctf_stream_put(struct bt_ctf_stream
*stream
);
169 #endif /* BABELTRACE_CTF_WRITER_STREAM_H */
This page took 0.032766 seconds and 4 git commands to generate.