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/plugin/notification/notification.h>
39 struct bt_notification
;
40 struct bt_notification_iterator
;
42 struct bt_component_factory
;
45 typedef enum bt_component_status (*bt_plugin_init_func
)(
46 struct bt_component_factory
*factory
);
47 typedef void (*bt_plugin_exit_func
)(void);
50 * Component private data deallocation function type.
52 * @param component Component instance
54 typedef void (*bt_component_destroy_cb
)(struct bt_component
*component
);
57 * Component initialization function type.
59 * A component's private data and required callbacks must be set by this
62 * @param component Component instance
63 * @param params A dictionary of component parameters
64 * @returns One of #bt_component_status values
66 typedef enum bt_component_status (*bt_component_init_cb
)(
67 struct bt_component
*component
, struct bt_value
*params
);
70 * Get a component's private data.
72 * @param component Component of which to get the private data
73 * @returns Component's private data
75 extern void *bt_component_get_private_data(struct bt_component
*component
);
78 * Set a component's private data.
80 * @param component Component of which to set the private data
81 * @param data Component private data
82 * @returns One of #bt_component_status values
84 extern enum bt_component_status
bt_component_set_private_data(
85 struct bt_component
*component
, void *data
);
88 * Set a component's private data cleanup function.
90 * @param component Component of which to set the private data destruction
92 * @param data Component private data clean-up function
93 * @returns One of #bt_component_status values
95 extern enum bt_component_status
bt_component_set_destroy_cb(
96 struct bt_component
*component
,
97 bt_component_destroy_cb destroy
);
99 /** bt_component_souce */
101 * Iterator initialization function type.
103 * A notification iterator's private data, deinitialization, next, and get
104 * callbacks must be set by this function.
106 * @param source Source component instance
107 * @param iterator Notification iterator instance
109 typedef enum bt_component_status (*bt_component_source_init_iterator_cb
)(
110 struct bt_component
*, struct bt_notification_iterator
*);
113 * Set a source component's iterator initialization function.
115 * @param source Source component instance
116 * @param init_iterator Notification iterator initialization callback
118 extern enum bt_component_status
119 bt_component_source_set_iterator_init_cb(struct bt_component
*source
,
120 bt_component_source_init_iterator_cb init_iterator
);
122 /** bt_component_sink */
124 * Notification handling function type.
126 * @param sink Sink component instance
127 * @param notificattion Notification to handle
128 * @returns One of #bt_component_status values
130 typedef enum bt_component_status (*bt_component_sink_handle_notification_cb
)(
131 struct bt_component
*, struct bt_notification
*);
134 * Set a sink component's notification handling callback.
136 * @param sink Sink component instance
137 * @param handle_notification Notification handling callback
138 * @returns One of #bt_component_status values
140 extern enum bt_component_status
141 bt_component_sink_set_handle_notification_cb(struct bt_component
*sink
,
142 bt_component_sink_handle_notification_cb handle_notification
);
145 * Register a sink to a given notification type.
147 * A sink is always registered to notifications of type
148 * BT_NOTIFICATION_TYPE_EVENT. However, it may opt to receive any (or all)
149 * other notification type(s).
151 * @param sink Sink component instance.
152 * @param type One of #bt_notification_type
153 * @returns One of #bt_component_status
155 extern enum bt_component_status
156 bt_component_sink_register_notification_type(struct bt_component
*sink
,
157 enum bt_notification_type type
);
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 * Get 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 */