1 #ifndef BABELTRACE_PLUGIN_NOTIFICATION_ITERATOR_H
2 #define BABELTRACE_PLUGIN_NOTIFICATION_ITERATOR_H
5 * BabelTrace - Plug-in 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
36 struct bt_notification
;
37 struct bt_notification_iterator
;
40 * Status code. Errors are always negative.
42 enum bt_notification_iterator_status
{
43 /** No more notifications to be delivered. */
44 BT_NOTIFICATION_ITERATOR_STATUS_END
= 1,
45 /** No error, okay. */
46 BT_NOTIFICATION_ITERATOR_STATUS_OK
= 0,
47 /** Invalid arguments. */
48 BT_NOTIFICATION_ITERATOR_STATUS_INVAL
= -1,
50 BT_NOTIFICATION_ITERATOR_STATUS_ERROR
= -2,
52 BT_NOTIFICATION_ITERATOR_STATUS_NOMEM
= -3,
53 /** Unsupported iterator feature. */
54 BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED
= -4,
59 * Notification iterator seek reference.
61 enum bt_notification_iterator_seek_origin
{
62 /** Seek at a time relative to the beginning of the trace. */
63 BT_NOTIFICATION_ITERATOR_SEEK_ORIGIN_BEGIN
= 0,
65 /** Seek at a time relative to the current position. */
66 BT_NOTIFICATION_ITERATOR_SEEK_ORIGIN_CURRENT
= 1,
68 /** Seek at a time relative to the end of the trace. */
69 BT_NOTIFICATION_ITERATOR_SEEK_ORIGIN_END
= 2,
71 /** Seek at a time relative to EPOCH. */
72 BT_NOTIFICATION_ITERATOR_SEEK_ORIGIN_EPOCH
= 3,
76 * Get current notification at iterator's position.
78 * This functions will <b>not</b> advance the cursor's position.
79 * The returned notification's reference count is already incremented.
81 * @param iterator Iterator instance
82 * @returns Returns a bt_notification instance
86 extern struct bt_notification
*bt_notification_iterator_get_notification(
87 struct bt_notification_iterator
*iterator
);
90 * Advance the iterator's position forward.
92 * This function can be called repeatedly to iterate through the iterator's
95 * @param iterator Iterator instance
96 * @returns Returns a bt_notification instance
98 * @see bt_notification_iterator_get_notification()
100 extern enum bt_notification_iterator_status
101 bt_notification_iterator_next(struct bt_notification_iterator
*iterator
);
104 * Seek iterator to time.
106 * Sets the iterator's position for the trace associated with the iterator.
107 * The new position is computed by adding \p time to the position specified
110 * time is expressed in nanoseconds.
112 * @param iterator Iterator instance
113 * @param seek_origin One of #bt_notification_iterator_seek_type values.
114 * @returns One of #bt_notification_iterator_status values;
115 * if \iterator does not support seeking,
116 * #BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED is
119 * @see bt_notification_iterator_get_notification()
121 extern enum bt_notification_iterator_status
bt_notification_iterator_seek_time(
122 struct bt_notification_iterator
*iterator
,
123 enum bt_notification_iterator_seek_origin seek_origin
,
126 extern struct bt_component
*bt_notification_iterator_get_component(
127 struct bt_notification_iterator
*iterator
);
133 #endif /* BABELTRACE_PLUGIN_NOTIFICATION_ITERATOR_H */