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
33 #include <babeltrace/objects.h>
34 #include <babeltrace/objects.h>
40 struct bt_notification
;
41 struct bt_notification_iterator
;
45 * Component private data deallocation function type.
47 * @param component Component instance
49 typedef void (*bt_component_destroy_cb
)(struct bt_component
*component
);
52 * Source component initialization function type.
54 * A source component's iterator initialization callback, private data and
55 * deinitialization callback must be set by this function.
57 * @param component Component instance
59 typedef struct bt_component
*(*bt_component_source_init_cb
)(
60 struct bt_component
*component
);
63 * Sink component initialization function type.
65 * A sink component's notification handling callback, private data and
66 * deinitialization callback must be set by this function.
68 * @param component Component instance
70 typedef struct bt_component
*(*bt_component_sink_init_cb
)(
71 struct bt_component
*component
);
74 * Iterator initialization function type.
76 * @param component Component instance
77 * @param iterator Iterator instance
79 typedef enum bt_component_status (*bt_component_source_iterator_init_cb
)(
80 struct bt_component
*component
,
81 struct bt_notification_iterator
*iterator
);
84 * Get a component's private data.
86 * @param component Component of which to get the private data
87 * @returns Component's private data
89 extern void *bt_component_get_private_data(struct bt_component
*component
);
92 * Set a component's private data.
94 * @param component Component of which to set the private data
95 * @param data Component private data
96 * @returns One of #bt_component_status values
98 extern enum bt_component_status
bt_component_set_private_data(
99 struct bt_component
*component
, void *data
);
102 * Set a component's private data cleanup function.
104 * @param component Component of which to set the private data destruction
106 * @param data Component private data clean-up function
107 * @returns One of #bt_component_status values
109 extern enum bt_component_status
bt_component_set_destroy_cb(
110 struct bt_component
*component
,
111 bt_component_destroy_cb destroy
);
113 /** bt_component_souce */
115 * Iterator initialization function type.
117 * A notification iterator's private data, deinitialization, next, and get
118 * callbacks must be set by this function.
120 * @param component Component instance
121 * @param iterator Notification iterator instance
123 typedef enum bt_component_status (*bt_component_source_init_iterator_cb
)(
124 struct bt_component
*component
,
125 struct bt_notification_iterator
*iterator
);
128 * Set a source component's iterator initialization function.
130 * @param component Component instance
131 * @param init_iterator Notification iterator initialization callback
133 extern enum bt_component_status
134 bt_component_source_set_iterator_init_cb(struct bt_component
*component
,
135 bt_component_source_init_iterator_cb init_iterator
);
137 /** bt_component_sink */
139 * Notification handling function type.
141 * @param component Component instance
142 * @param notificattion Notification to handle
143 * @returns One of #bt_component_status values
145 typedef enum bt_component_status (*bt_component_sink_handle_notification_cb
)(
146 struct bt_component
*, struct bt_notification
*);
149 * Set a sink component's notification handling callback.
151 * @param component Component instance
152 * @param handle_notification Notification handling callback
153 * @returns One of #bt_component_status values
155 extern enum bt_component_status
156 bt_component_sink_set_handle_notification_cb(struct bt_component
*component
,
157 bt_component_sink_handle_notification_cb handle_notification
);
159 /** bt_component_notification_iterator */
161 * Function returning an iterator's current notification.
163 * @param iterator Notification iterator instance
164 * @returns A notification instance
166 typedef struct bt_notification
*(*bt_notification_iterator_get_cb
)(
167 struct bt_notification_iterator
*iterator
);
170 * Function advancing an iterator's position of one element.
172 * @param iterator Notification iterator instance
173 * @returns One of #bt_notification_iterator_status values
175 typedef enum bt_notification_iterator_status (*bt_notification_iterator_next_cb
)(
176 struct bt_notification_iterator
*iterator
);
179 * Function cleaning-up an iterator's private data on destruction.
181 * @param iterator Notification iterator instance
183 typedef void (*bt_notification_iterator_destroy_cb
)(
184 struct bt_notification_iterator
*iterator
);
187 * Set an iterator's "get" callback which return the current notification.
189 * @param iterator Notification iterator instance
190 * @param get Notification return callback
191 * @returns One of #bt_notification_iterator_status values
193 extern enum bt_notification_iterator_status
194 bt_notification_iterator_set_get_cb(struct bt_notification_iterator
*iterator
,
195 bt_notification_iterator_get_cb get
);
198 * Set an iterator's "next" callback which advances the iterator's position.
200 * @param iterator Notification iterator instance
201 * @param next Iterator "next" callback
202 * @returns One of #bt_notification_iterator_status values
204 extern enum bt_notification_iterator_status
205 bt_notification_iterator_set_next_cb(struct bt_notification_iterator
*iterator
,
206 bt_notification_iterator_next_cb next
);
209 * Set an iterator's "destroy" callback.
211 * @param iterator Notification iterator instance
212 * @param next Iterator destruction callback
213 * @returns One of #bt_notification_iterator_status values
215 extern enum bt_notification_iterator_status
216 bt_notification_iterator_set_destroy_cb(
217 struct bt_notification_iterator
*iterator
,
218 bt_notification_iterator_destroy_cb destroy
);
221 * Set an iterator's private data.
223 * @param iterator Notification iterator instance
224 * @param data Iterator private data
225 * @returns One of #bt_notification_iterator_status values
227 extern enum bt_notification_iterator_status
228 bt_notification_iterator_set_private_data(
229 struct bt_notification_iterator
*iterator
, void *data
);
232 * Gett an iterator's private data.
234 * @param iterator Notification iterator instance
235 * @returns Iterator instance private data
237 extern void *bt_notification_iterator_get_private_data(
238 struct bt_notification_iterator
*iterator
);
244 #endif /* BABELTRACE_PLUGIN_SYSTEM_H */