1 #ifndef BABELTRACE_PLUGIN_ITERATOR_INTERNAL_H
2 #define BABELTRACE_PLUGIN_ITERATOR_INTERNAL_H
5 * BabelTrace - Notification Iterator Internal
7 * Copyright 2015 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
30 #include <babeltrace/babeltrace-internal.h>
31 #include <babeltrace/plugin/plugin-system.h>
32 #include <babeltrace/ctf-writer/ref-internal.h>
34 struct bt_notification_iterator
{
35 struct bt_ctf_ref ref_count
;
36 bt_notification_iterator_get_cb get
;
37 bt_notification_iterator_next_cb next
;
42 * Allocate a notification iterator.
44 * @param component Component instance
45 * @returns A notification iterator instance
48 struct bt_notification_iterator
*bt_notification_iterator_create(
49 struct bt_component
*component
);
52 * Validate a notification iterator.
54 * @param iterator Notification iterator instance
55 * @returns One of #bt_component_status values
58 enum bt_notification_iterator_status
bt_notification_iterator_validate(
59 struct bt_notification_iterator
*iterator
);
62 * Destroy a notification iterator.
64 * @param iterator Notification iterator instance
67 void bt_notification_iterator_destroy(
68 struct bt_notification_iterator
*iterator
);
70 #endif /* BABELTRACE_PLUGIN_ITERATOR_INTERNAL_H */