source interface documentation
[babeltrace.git] / include / babeltrace / plugin / source.h
CommitLineData
90354d3a
JG
1#ifndef BABELTRACE_PLUGIN_SOURCE_H
2#define BABELTRACE_PLUGIN_SOURCE_H
3
4/*
0db5ca2c 5 * BabelTrace - Source Plug-in Interface
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
33extern "C" {
34#endif
35
36struct bt_plugin;
37struct bt_notification_iterator;
0c881a11
JG
38
39/**
40 * Iterator creation function type.
41 *
42 * @param plugin Plug-in instance
43 */
b5c2631a 44typedef struct bt_notification_iterator *(
0c881a11
JG
45 *bt_plugin_source_iterator_create_func)(
46 struct bt_plugin *plugin);
90354d3a 47
0c881a11
JG
48/**
49 * Create an iterator on a plug-in instance.
50 *
51 * @param plugin Plug-in instance
52 * @returns Notification iterator instance
53 */
54struct bt_notification_iterator *bt_plugin_source_create_iterator(
90354d3a
JG
55 struct bt_plugin *plugin);
56
90354d3a
JG
57#ifdef __cplusplus
58}
59#endif
60
61#endif /* BABELTRACE_PLUGIN_SOURCE_H */
This page took 0.02438 seconds and 4 git commands to generate.