1 #ifndef BABELTRACE_PLUGIN_SYSTEM_H
2 #define BABELTRACE_PLUGIN_SYSTEM_H
5 * BabelTrace - Babeltrace Plug-in System Interface
7 * This interface is provided for plug-ins to use the Babeltrace
8 * plug-in system facilities.
10 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
12 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
14 * Permission is hereby granted, free of charge, to any person obtaining a copy
15 * of this software and associated documentation files (the "Software"), to deal
16 * in the Software without restriction, including without limitation the rights
17 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
18 * copies of the Software, and to permit persons to whom the Software is
19 * furnished to do so, subject to the following conditions:
21 * The above copyright notice and this permission notice shall be included in
22 * all copies or substantial portions of the Software.
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
25 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
27 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
29 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
37 struct bt_notification
;
38 struct bt_notification_iterator
;
42 * Component private data deallocation function type.
44 * @param component Component instance
46 typedef void (*bt_component_destroy_cb
)(struct bt_component
*component
);
49 * Source component initialization function type.
51 * A source component's iterator initialization callback, private data and
52 * deinitialization callback must be set by this function.
54 * @param component Component instance
55 * @returns One of #bt_component_status values
57 typedef enum bt_component_status (*bt_component_source_init_cb
)(
58 struct bt_component
*component
);
61 * Sink component initialization function type.
63 * A sink component's notification handling callback, private data and
64 * deinitialization callback must be set by this function.
66 * @param component Component instance
67 * @returns One of #bt_component_status values
69 typedef enum bt_component_status (*bt_component_sink_init_cb
)(
70 struct bt_component
*component
);
73 * Iterator initialization function type.
75 * @param component Component instance
76 * @param iterator Iterator instance
78 typedef enum bt_component_status (*bt_component_source_iterator_init_cb
)(
79 struct bt_component
*component
,
80 struct bt_notification_iterator
*iterator
);
83 * Get a component's private data.
85 * @param component Component of which to get the private data
86 * @returns Component's private data
88 extern void *bt_component_get_private_data(struct bt_component
*component
);
91 * Set a component's private data.
93 * @param component Component of which to set the private data
94 * @param data Component private data
95 * @returns One of #bt_component_status values
97 extern enum bt_component_status
bt_component_set_private_data(
98 struct bt_component
*component
, void *data
);
101 * Set a component's private data cleanup function.
103 * @param component Component of which to set the private data destruction
105 * @param data Component private data clean-up function
106 * @returns One of #bt_component_status values
108 extern enum bt_component_status
bt_component_set_destroy_cb(
109 struct bt_component
*component
,
110 bt_component_destroy_cb destroy
);
112 /** bt_component_souce */
114 * Iterator initialization function type.
116 * A notification iterator's private data, deinitialization, next, and get
117 * callbacks must be set by this function.
119 * @param component Component instance
120 * @param iterator Notification iterator instance
122 typedef enum bt_component_status (*bt_component_source_init_iterator_cb
)(
123 struct bt_component
*component
,
124 struct bt_notification_iterator
*iterator
);
127 * Set a source component's iterator initialization function.
129 * @param component Component instance
130 * @param init_iterator Notification iterator initialization callback
132 extern enum bt_component_status
133 bt_component_source_set_iterator_init_cb(struct bt_component
*component
,
134 bt_component_source_init_iterator_cb init_iterator
);
136 /** bt_component_sink */
138 * Notification handling function type.
140 * @param component Component instance
141 * @param notificattion Notification to handle
142 * @returns One of #bt_component_status values
144 typedef enum bt_component_status (*bt_component_sink_handle_notification_cb
)(
145 struct bt_component
*, struct bt_notification
*);
148 * Set a sink component's notification handling callback.
150 * @param component Component instance
151 * @param handle_notification Notification handling callback
152 * @returns One of #bt_component_status values
154 extern enum bt_component_status
155 bt_component_sink_set_handle_notification_cb(struct bt_component
*component
,
156 bt_component_sink_handle_notification_cb handle_notification
);
158 /** bt_component_notification_iterator */
160 * Function returning an iterator's current notification.
162 * @param iterator Notification iterator instance
163 * @returns A notification instance
165 typedef struct bt_notification
*(*bt_notification_iterator_get_cb
)(
166 struct bt_notification_iterator
*iterator
);
169 * Function advancing an iterator's position of one element.
171 * @param iterator Notification iterator instance
172 * @returns One of #bt_notification_iterator_status values
174 typedef enum bt_notification_iterator_status (*bt_notification_iterator_next_cb
)(
175 struct bt_notification_iterator
*iterator
);
178 * Function cleaning-up an iterator's private data on destruction.
180 * @param iterator Notification iterator instance
182 typedef void (*bt_notification_iterator_destroy_cb
)(
183 struct bt_notification_iterator
*iterator
);
186 * Set an iterator's "get" callback which return the current notification.
188 * @param iterator Notification iterator instance
189 * @param get Notification return callback
190 * @returns One of #bt_notification_iterator_status values
192 extern enum bt_notification_iterator_status
193 bt_notification_iterator_set_get_cb(struct bt_notification_iterator
*iterator
,
194 bt_notification_iterator_get_cb get
);
197 * Set an iterator's "next" callback which advances the iterator's position.
199 * @param iterator Notification iterator instance
200 * @param next Iterator "next" callback
201 * @returns One of #bt_notification_iterator_status values
203 extern enum bt_notification_iterator_status
204 bt_notification_iterator_set_next_cb(struct bt_notification_iterator
*iterator
,
205 bt_notification_iterator_next_cb next
);
208 * Set an iterator's "destroy" callback.
210 * @param iterator Notification iterator instance
211 * @param next Iterator destruction callback
212 * @returns One of #bt_notification_iterator_status values
214 extern enum bt_notification_iterator_status
215 bt_notification_iterator_set_destroy_cb(
216 struct bt_notification_iterator
*iterator
,
217 bt_notification_iterator_destroy_cb destroy
);
220 * Set an iterator's private data.
222 * @param iterator Notification iterator instance
223 * @param data Iterator private data
224 * @returns One of #bt_notification_iterator_status values
226 extern enum bt_notification_iterator_status
227 bt_notification_iterator_set_private_data(
228 struct bt_notification_iterator
*iterator
, void *data
);
231 * Gett an iterator's private data.
233 * @param iterator Notification iterator instance
234 * @returns Iterator instance private data
236 extern void *bt_notification_iterator_get_private_data(
237 struct bt_notification_iterator
*iterator
);
243 #endif /* BABELTRACE_PLUGIN_SYSTEM_H */