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/plugin/notification/iterator.h>
40 struct bt_notification
;
43 * Component private data deallocation function type.
45 * @param component Component instance
47 typedef void (*bt_component_destroy_cb
)(struct bt_component
*component
);
50 * Iterator creation function type.
52 * @param component Component instance
54 typedef struct bt_notification_iterator
*(
55 *bt_component_source_iterator_create_cb
)(
56 struct bt_component
*component
);
59 * Notification handling function type.
61 * @param component Component instance
62 * @param notificattion Notification to handle
63 * @returns One of #bt_component_status values
65 typedef enum bt_component_status (*bt_component_sink_handle_notification_cb
)(
66 struct bt_component
*, struct bt_notification
*);
68 typedef struct bt_notification
*(bt_notification_iterator_get_notification_cb
)(
69 struct bt_notification_iterator
*);
71 typedef enum bt_notification_iterator_status (bt_notification_iterator_next_cb
)(
72 struct bt_notification_iterator
*);
75 * Get a component's private (implementation) data.
77 * @param component Component of which to get the private data
79 extern void *bt_component_get_private_data(struct bt_component
*component
);
82 * Set a component's private (implementation) data.
84 * @param component Component of which to set the private data
85 * @param data Component private data
87 extern enum bt_component_status
bt_component_set_private_data(struct bt_component
*component
,
91 /** Notification iterator functions */
93 * Allocate a notification iterator.
95 * @param component Component instance
96 * @param next_cb Callback advancing to the next notification
97 * @param notification_cb Callback providing the current notification
98 * @returns A notification iterator instance
100 extern struct bt_notification_iterator
*bt_notification_iterator_create(
101 struct bt_component
*component
,
102 bt_notification_iterator_next_cb next_cb
,
103 bt_notification_iterator_get_notification_cb notification_cb
);
109 #endif /* BABELTRACE_PLUGIN_SYSTEM_H */