ref.h: doc: fix typo
[babeltrace.git] / include / babeltrace / plugin / notification / iterator-internal.h
CommitLineData
47e5a032
JG
1#ifndef BABELTRACE_PLUGIN_ITERATOR_INTERNAL_H
2#define BABELTRACE_PLUGIN_ITERATOR_INTERNAL_H
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>
31#include <babeltrace/plugin/plugin-system.h>
fb2dcc52 32#include <babeltrace/ref-internal.h>
34a9ed19 33#include <babeltrace/plugin/notification/iterator.h>
47e5a032
JG
34
35struct bt_notification_iterator {
b8a06801 36 struct bt_object base;
413bc2c4 37 struct bt_component *component;
47e5a032
JG
38 bt_notification_iterator_get_cb get;
39 bt_notification_iterator_next_cb next;
2e2dff0f 40 bt_notification_iterator_seek_time_cb seek_time;
47e5a032 41 void *user_data;
8738a040 42 bt_notification_iterator_destroy_cb user_destroy;
47e5a032
JG
43};
44
45/**
46 * Allocate a notification iterator.
47 *
48 * @param component Component instance
49 * @returns A notification iterator instance
50 */
51BT_HIDDEN
52struct bt_notification_iterator *bt_notification_iterator_create(
53 struct bt_component *component);
54
55/**
56 * Validate a notification iterator.
57 *
58 * @param iterator Notification iterator instance
59 * @returns One of #bt_component_status values
60 */
61BT_HIDDEN
62enum bt_notification_iterator_status bt_notification_iterator_validate(
63 struct bt_notification_iterator *iterator);
64
47e5a032 65#endif /* BABELTRACE_PLUGIN_ITERATOR_INTERNAL_H */
This page took 0.027377 seconds and 4 git commands to generate.