Visibility: split graph API into public and private interfaces
[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>
33b34c43 33#include <babeltrace/component/notification/iterator.h>
890882ef 34#include <babeltrace/component/notification/private-iterator.h>
47e5a032
JG
35
36struct bt_notification_iterator {
b8a06801 37 struct bt_object base;
413bc2c4 38 struct bt_component *component;
47e5a032
JG
39 void *user_data;
40};
41
890882ef
PP
42static inline
43struct bt_notification_iterator *bt_notification_iterator_from_private(
44 struct bt_private_notification_iterator *private_notification_iterator)
45{
46 return (void *) private_notification_iterator;
47}
48
49static inline
50struct bt_private_notification_iterator *
51bt_private_notification_iterator_from_notification_iterator(
52 struct bt_notification_iterator *notification_iterator)
53{
54 return (void *) notification_iterator;
55}
56
47e5a032
JG
57/**
58 * Allocate a notification iterator.
59 *
60 * @param component Component instance
61 * @returns A notification iterator instance
62 */
63BT_HIDDEN
64struct bt_notification_iterator *bt_notification_iterator_create(
65 struct bt_component *component);
66
67/**
68 * Validate a notification iterator.
69 *
70 * @param iterator Notification iterator instance
71 * @returns One of #bt_component_status values
72 */
73BT_HIDDEN
74enum bt_notification_iterator_status bt_notification_iterator_validate(
75 struct bt_notification_iterator *iterator);
76
33b34c43 77#endif /* BABELTRACE_COMPONENT_NOTIFICATION_ITERATOR_INTERNAL_H */
This page took 0.029653 seconds and 4 git commands to generate.