ref.h: doc: fix typo
[babeltrace.git] / include / babeltrace / plugin / source-internal.h
CommitLineData
0777b693
JG
1#ifndef BABELTRACE_PLUGIN_SOURCE_INTERNAL_H
2#define BABELTRACE_PLUGIN_SOURCE_INTERNAL_H
3
4/*
0d884c50 5 * BabelTrace - Source Component internal
0777b693
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 <babeltrace/babeltrace-internal.h>
0d884c50 31#include <babeltrace/plugin/component-internal.h>
fb2dcc52 32#include <babeltrace/plugin/component-class-internal.h>
fd0f910d 33#include <babeltrace/plugin/plugin-system.h>
0777b693 34
7c7c0433
JG
35struct bt_value;
36
fb2dcc52
JG
37struct bt_component_source_class {
38 struct bt_component_class parent;
fb2dcc52
JG
39};
40
0d884c50
JG
41struct bt_component_source {
42 struct bt_component parent;
8738a040 43 bt_component_source_init_iterator_cb init_iterator;
0777b693
JG
44};
45
8738a040
JG
46/**
47 * Allocate a source component.
48 *
fb2dcc52 49 * @param class Component class
7c7c0433 50 * @param params A dictionary of component parameters
8738a040
JG
51 * @returns A source component instance
52 */
53BT_HIDDEN
7c7c0433
JG
54struct bt_component *bt_component_source_create(
55 struct bt_component_class *class, struct bt_value *params);
56
57/**
58 * Validate a source component.
59 *
60 * @param component Source component instance to validate
61 * @returns One of #bt_component_status
62 */
63BT_HIDDEN
64enum bt_component_status bt_component_source_validate(
65 struct bt_component *component);
8738a040 66
0777b693 67#endif /* BABELTRACE_PLUGIN_SOURCE_INTERNAL_H */
This page took 0.026896 seconds and 4 git commands to generate.