Commit | Line | Data |
---|---|---|
1ca80abd PP |
1 | #ifndef BABELTRACE_GRAPH_NOTIFICATION_ITERATOR_H |
2 | #define BABELTRACE_GRAPH_NOTIFICATION_ITERATOR_H | |
90354d3a JG |
3 | |
4 | /* | |
a19804e7 | 5 | * BabelTrace - Notification Iterator |
90354d3a JG |
6 | * |
7 | * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
8 | * | |
9 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
10 | * | |
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: | |
17 | * | |
18 | * The above copyright notice and this permission notice shall be included in | |
19 | * all copies or substantial portions of the Software. | |
20 | * | |
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 | |
27 | * SOFTWARE. | |
28 | */ | |
29 | ||
30 | #include <stdint.h> | |
31 | ||
32 | #ifdef __cplusplus | |
33 | extern "C" { | |
34 | #endif | |
35 | ||
36 | struct bt_notification; | |
37 | struct bt_notification_iterator; | |
38 | ||
1d7b7871 JG |
39 | /** |
40 | * Status code. Errors are always negative. | |
41 | */ | |
42 | enum bt_notification_iterator_status { | |
bd14d768 PP |
43 | /** Canceled. */ |
44 | BT_NOTIFICATION_ITERATOR_STATUS_CANCELED = 125, | |
7cdc2bab | 45 | /** No notifications available for now. Try again later. */ |
fe8ad2b6 | 46 | BT_NOTIFICATION_ITERATOR_STATUS_AGAIN = 11, |
663618ee JG |
47 | /** No more notifications to be delivered. */ |
48 | BT_NOTIFICATION_ITERATOR_STATUS_END = 1, | |
d01e0f33 JG |
49 | /** No error, okay. */ |
50 | BT_NOTIFICATION_ITERATOR_STATUS_OK = 0, | |
1d7b7871 | 51 | /** Invalid arguments. */ |
fe8ad2b6 | 52 | BT_NOTIFICATION_ITERATOR_STATUS_INVALID = -22, |
1d7b7871 | 53 | /** General error. */ |
fe8ad2b6 | 54 | BT_NOTIFICATION_ITERATOR_STATUS_ERROR = -1, |
5b29e799 | 55 | /** Out of memory. */ |
fe8ad2b6 | 56 | BT_NOTIFICATION_ITERATOR_STATUS_NOMEM = -12, |
1d7b7871 | 57 | /** Unsupported iterator feature. */ |
fe8ad2b6 | 58 | BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED = -2, |
1d7b7871 JG |
59 | }; |
60 | ||
1d7b7871 JG |
61 | /** |
62 | * Get current notification at iterator's position. | |
63 | * | |
64 | * This functions will <b>not</b> advance the cursor's position. | |
65 | * The returned notification's reference count is already incremented. | |
66 | * | |
9900dfa7 | 67 | * @param iterator Iterator instance |
1d7b7871 JG |
68 | * @returns Returns a bt_notification instance |
69 | * | |
448143d9 | 70 | * @see bt_put() |
1d7b7871 | 71 | */ |
0db5ca2c | 72 | extern struct bt_notification *bt_notification_iterator_get_notification( |
90354d3a JG |
73 | struct bt_notification_iterator *iterator); |
74 | ||
1d7b7871 JG |
75 | /** |
76 | * Advance the iterator's position forward. | |
77 | * | |
78 | * This function can be called repeatedly to iterate through the iterator's | |
79 | * associated trace. | |
80 | * | |
81 | * @param iterator Iterator instance | |
82 | * @returns Returns a bt_notification instance | |
83 | * | |
84 | * @see bt_notification_iterator_get_notification() | |
85 | */ | |
86 | extern enum bt_notification_iterator_status | |
87 | bt_notification_iterator_next(struct bt_notification_iterator *iterator); | |
88 | ||
90354d3a JG |
89 | #ifdef __cplusplus |
90 | } | |
91 | #endif | |
92 | ||
1ca80abd | 93 | #endif /* BABELTRACE_GRAPH_NOTIFICATION_ITERATOR_H */ |