b9d813e4b815f26f6d295d42eaf9e53b808f70a4
1 #ifndef BABELTRACE_CTF_IR_EVENT_H
2 #define BABELTRACE_CTF_IR_EVENT_H
5 * BabelTrace - CTF IR: Event
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
35 #include <babeltrace/values.h>
41 struct bt_ctf_event_class
;
44 struct bt_ctf_field_type
;
45 struct bt_ctf_stream_class
;
49 * bt_ctf_event_create: instanciate an event.
51 * Allocate a new event of the given event class. The creation of an event
52 * sets its reference count to 1. Each instance shares the ownership of the
53 * event class using its reference count.
55 * An event class must be associated with a stream class before events
56 * may be instanciated.
58 * @param event_class Event class.
60 * Returns an allocated field type on success, NULL on error.
62 extern struct bt_ctf_event
*bt_ctf_event_create(
63 struct bt_ctf_event_class
*event_class
);
66 * bt_ctf_event_get_class: get an event's class.
70 * Returns the event's class, NULL on error.
72 extern struct bt_ctf_event_class
*bt_ctf_event_get_class(
73 struct bt_ctf_event
*event
);
76 * bt_ctf_event_get_stream: get an event's associated stream.
80 * Returns the event's associated stream, NULL on error.
82 extern struct bt_ctf_stream
*bt_ctf_event_get_stream(
83 struct bt_ctf_event
*event
);
86 * bt_ctf_event_get_clock: get an event's associated clock.
90 * Returns the event's clock, NULL on error.
92 extern struct bt_ctf_clock
*bt_ctf_event_get_clock(
93 struct bt_ctf_event
*event
);
96 * bt_ctf_event_get_payload_field: get an event's payload.
98 * @param event Event instance.
100 * Returns a field instance on success, NULL on error.
102 extern struct bt_ctf_field
*bt_ctf_event_get_payload_field(
103 struct bt_ctf_event
*event
);
106 * bt_ctf_event_set_payload_field: set an event's payload.
108 * @param event Event instance.
109 * @param payload Field instance (must be a structure).
111 * Returns 0 on success, a negative value on error.
113 extern int bt_ctf_event_set_payload_field(struct bt_ctf_event
*event
,
114 struct bt_ctf_field
*payload
);
117 * bt_ctf_event_get_payload: get an event's field.
119 * Returns the field matching "name". bt_ctf_field_put() must be called on the
122 * @param event Event instance.
123 * @param name Event field name, see notes.
125 * Returns a field instance on success, NULL on error.
127 * Note: Passing a name will cause the function to perform a look-up by
128 * name assuming the event's payload is a structure. This will return
129 * the raw payload instance if name is NULL.
131 extern struct bt_ctf_field
*bt_ctf_event_get_payload(struct bt_ctf_event
*event
,
135 * bt_ctf_event_set_payload: set an event's field.
137 * Set a manually allocated field as an event's payload. The event will share
138 * the field's ownership by using its reference count.
139 * bt_ctf_field_put() must be called on the returned value.
141 * @param event Event instance.
142 * @param name Event field name, see notes.
143 * @param value Instance of a field whose type corresponds to the event's field.
145 * Returns 0 on success, a negative value on error.
147 * Note: The function will return an error if a name is provided and the payload
148 * type is not a structure. If name is NULL, the payload field will be set
149 * directly and must match the event class' payload's type.
151 extern int bt_ctf_event_set_payload(struct bt_ctf_event
*event
,
153 struct bt_ctf_field
*value
);
156 * bt_ctf_event_get_payload_by_index: Get event's field by index.
158 * Returns the field associated with the provided index. bt_ctf_field_put()
159 * must be called on the returned value. The indexes to be provided are
160 * the same as can be retrieved from the event class.
162 * @param event Event.
163 * @param index Index of field.
165 * Returns the event's field, NULL on error.
167 * Note: Will return an error if the payload's type is not a structure.
169 extern struct bt_ctf_field
*bt_ctf_event_get_payload_by_index(
170 struct bt_ctf_event
*event
, int index
);
173 * bt_ctf_event_get_header: get an event's header.
175 * @param event Event instance.
177 * Returns a field instance on success, NULL on error.
179 extern struct bt_ctf_field
*bt_ctf_event_get_header(
180 struct bt_ctf_event
*event
);
183 * bt_ctf_event_set_header: set an event's header.
185 * The event header's type must match the stream class' event
188 * @param event Event instance.
189 * @param header Event header field instance.
191 * Returns a field instance on success, NULL on error.
193 extern int bt_ctf_event_set_header(
194 struct bt_ctf_event
*event
,
195 struct bt_ctf_field
*header
);
198 * bt_ctf_event_get_event_context: Get an event's context
200 * @param event_class Event class.
202 * Returns a field on success (a structure), NULL on error.
204 * Note: This function is named this way instead of the expected
205 * "bt_ctf_event_get_context" in order to work around a name clash with
206 * an unrelated function bearing this name in context.h.
208 extern struct bt_ctf_field
*bt_ctf_event_get_event_context(
209 struct bt_ctf_event
*event
);
212 * bt_ctf_event_set_event_context: Set an event's context
214 * @param event Event.
215 * @param context Event context field (must match the event class'
218 * Returns 0 on success, a negative value on error.
220 extern int bt_ctf_event_set_event_context(struct bt_ctf_event
*event
,
221 struct bt_ctf_field
*context
);
224 * bt_ctf_event_get_stream_event_context: Get an event's stream event context
226 * @param event_class Event class.
228 * Returns a field on success (a structure), NULL on error.
230 extern struct bt_ctf_field
*bt_ctf_event_get_stream_event_context(
231 struct bt_ctf_event
*event
);
234 * bt_ctf_event_set_stream_event_context: Set an event's stream event context
236 * @param event Event.
237 * @param context Event stream context field (must match the stream class'
238 * stream event context type).
240 * Returns 0 on success, a negative value on error.
242 extern int bt_ctf_event_set_stream_event_context(struct bt_ctf_event
*event
,
243 struct bt_ctf_field
*context
);
245 extern int bt_ctf_event_set_packet(struct bt_ctf_event
*event
,
246 struct bt_ctf_packet
*packet
);
252 #endif /* BABELTRACE_CTF_IR_EVENT_H */
This page took 0.043703 seconds and 4 git commands to generate.