Update notification iterator's "init" function signature
[babeltrace.git] / include / babeltrace / component / notification / iterator-internal.h
CommitLineData
33b34c43
PP
1#ifndef BABELTRACE_COMPONENT_NOTIFICATION_ITERATOR_INTERNAL_H
2#define BABELTRACE_COMPONENT_NOTIFICATION_ITERATOR_INTERNAL_H
47e5a032
JG
3
4/*
5 * BabelTrace - Notification Iterator Internal
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 <babeltrace/babeltrace-internal.h>
890882ef 31#include <babeltrace/object-internal.h>
fb2dcc52 32#include <babeltrace/ref-internal.h>
41a2b7ae 33#include <babeltrace/component/notification/notification.h>
33b34c43 34#include <babeltrace/component/notification/iterator.h>
890882ef 35#include <babeltrace/component/notification/private-iterator.h>
47e5a032
JG
36
37struct bt_notification_iterator {
b8a06801 38 struct bt_object base;
413bc2c4 39 struct bt_component *component;
41a2b7ae 40 struct bt_notification *current_notification;
47e5a032
JG
41 void *user_data;
42};
43
890882ef
PP
44static inline
45struct bt_notification_iterator *bt_notification_iterator_from_private(
46 struct bt_private_notification_iterator *private_notification_iterator)
47{
48 return (void *) private_notification_iterator;
49}
50
51static inline
52struct bt_private_notification_iterator *
53bt_private_notification_iterator_from_notification_iterator(
54 struct bt_notification_iterator *notification_iterator)
55{
56 return (void *) notification_iterator;
57}
58
47e5a032
JG
59/**
60 * Allocate a notification iterator.
61 *
62 * @param component Component instance
63 * @returns A notification iterator instance
64 */
65BT_HIDDEN
66struct bt_notification_iterator *bt_notification_iterator_create(
67 struct bt_component *component);
68
69/**
70 * Validate a notification iterator.
71 *
72 * @param iterator Notification iterator instance
73 * @returns One of #bt_component_status values
74 */
75BT_HIDDEN
76enum bt_notification_iterator_status bt_notification_iterator_validate(
77 struct bt_notification_iterator *iterator);
78
33b34c43 79#endif /* BABELTRACE_COMPONENT_NOTIFICATION_ITERATOR_INTERNAL_H */
This page took 0.031603 seconds and 4 git commands to generate.