1 #ifndef BABELTRACE_GRAPH_NOTIFICATION_ITERATOR_H
2 #define BABELTRACE_GRAPH_NOTIFICATION_ITERATOR_H
5 * BabelTrace - Notification Iterator
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
31 #include <babeltrace/ref.h>
39 struct bt_notification
;
40 struct bt_notification_iterator
;
43 * Status code. Errors are always negative.
45 enum bt_notification_iterator_status
{
47 BT_NOTIFICATION_ITERATOR_STATUS_CANCELED
= 125,
48 /** No notifications available for now. Try again later. */
49 BT_NOTIFICATION_ITERATOR_STATUS_AGAIN
= 11,
50 /** No more notifications to be delivered. */
51 BT_NOTIFICATION_ITERATOR_STATUS_END
= 1,
52 /** No error, okay. */
53 BT_NOTIFICATION_ITERATOR_STATUS_OK
= 0,
54 /** Invalid arguments. */
55 BT_NOTIFICATION_ITERATOR_STATUS_INVALID
= -22,
57 BT_NOTIFICATION_ITERATOR_STATUS_ERROR
= -1,
59 BT_NOTIFICATION_ITERATOR_STATUS_NOMEM
= -12,
60 /** Unsupported iterator feature. */
61 BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED
= -2,
64 extern struct bt_notification
*bt_notification_iterator_borrow_notification(
65 struct bt_notification_iterator
*iterator
);
68 * Get current notification at iterator's position.
70 * This functions will <b>not</b> advance the cursor's position.
71 * The returned notification's reference count is already incremented.
73 * @param iterator Iterator instance
74 * @returns Returns a bt_notification instance
79 struct bt_notification
*bt_notification_iterator_get_notification(
80 struct bt_notification_iterator
*iterator
)
82 return bt_get(bt_notification_iterator_borrow_notification(iterator
));
86 * Advance the iterator's position forward.
88 * This function can be called repeatedly to iterate through the iterator's
91 * @param iterator Iterator instance
92 * @returns Returns a bt_notification instance
94 * @see bt_notification_iterator_get_notification()
96 extern enum bt_notification_iterator_status
97 bt_notification_iterator_next(struct bt_notification_iterator
*iterator
);
103 #endif /* BABELTRACE_GRAPH_NOTIFICATION_ITERATOR_H */