Commit | Line | Data |
---|---|---|
33b34c43 PP |
1 | #ifndef BABELTRACE_COMPONENT_COMPONENT_H |
2 | #define BABELTRACE_COMPONENT_COMPONENT_H | |
43de0e13 JG |
3 | |
4 | /* | |
33b34c43 | 5 | * BabelTrace - Babeltrace Component Interface |
43de0e13 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 | ||
cc469c42 | 30 | #include <babeltrace/graph/component-status.h> |
b2e0c907 PP |
31 | #include <babeltrace/graph/component-class.h> |
32 | #include <babeltrace/graph/notification-iterator.h> | |
33b34c43 | 33 | #include <babeltrace/values.h> |
543147fa | 34 | #include <stdbool.h> |
30d619df | 35 | |
43de0e13 JG |
36 | #ifdef __cplusplus |
37 | extern "C" { | |
38 | #endif | |
39 | ||
f60c8b34 JG |
40 | struct bt_component_class; |
41 | struct bt_component_graph; | |
42 | struct bt_component; | |
43 | struct bt_value; | |
72b913fb | 44 | struct bt_port; |
f60c8b34 | 45 | |
43de0e13 | 46 | /** |
d3e4dcd8 | 47 | * Create an instance of a component from a component class. |
2bd8a567 | 48 | * |
d3e4dcd8 PP |
49 | * @param component_class Component class of which to create an instance |
50 | * @param name Name of the new component instance, optional | |
51 | * @param params A dictionary of component parameters | |
52 | * @returns Returns a pointer to a new component instance | |
2bd8a567 | 53 | */ |
d3e4dcd8 PP |
54 | extern struct bt_component *bt_component_create( |
55 | struct bt_component_class *component_class, const char *name, | |
56 | struct bt_value *params); | |
33b34c43 | 57 | |
6358c163 PP |
58 | extern struct bt_component *bt_component_create_with_init_method_data( |
59 | struct bt_component_class *component_class, const char *name, | |
60 | struct bt_value *params, void *init_method_data); | |
61 | ||
d97bac96 | 62 | /** |
33b34c43 | 63 | * Get component's name. |
d97bac96 | 64 | * |
33b34c43 PP |
65 | * @param component Component instance of which to get the name |
66 | * @returns Returns a pointer to the component's name | |
d97bac96 | 67 | */ |
33b34c43 | 68 | extern const char *bt_component_get_name(struct bt_component *component); |
8738a040 | 69 | |
d97bac96 | 70 | /** |
33b34c43 | 71 | * Get component's class. |
d97bac96 | 72 | * |
33b34c43 PP |
73 | * @param component Component instance of which to get the class |
74 | * @returns The component's class | |
d97bac96 | 75 | */ |
33b34c43 PP |
76 | extern struct bt_component_class *bt_component_get_class( |
77 | struct bt_component *component); | |
47e5a032 | 78 | |
d3e4dcd8 PP |
79 | extern enum bt_component_class_type bt_component_get_class_type( |
80 | struct bt_component *component); | |
81 | ||
543147fa PP |
82 | static inline |
83 | bool bt_component_is_source(struct bt_component *component) | |
84 | { | |
85 | return bt_component_get_class_type(component) == | |
86 | BT_COMPONENT_CLASS_TYPE_SOURCE; | |
87 | } | |
88 | ||
89 | static inline | |
90 | bool bt_component_is_filter(struct bt_component *component) | |
91 | { | |
92 | return bt_component_get_class_type(component) == | |
93 | BT_COMPONENT_CLASS_TYPE_FILTER; | |
94 | } | |
95 | ||
96 | static inline | |
97 | bool bt_component_is_sink(struct bt_component *component) | |
98 | { | |
99 | return bt_component_get_class_type(component) == | |
100 | BT_COMPONENT_CLASS_TYPE_SINK; | |
101 | } | |
102 | ||
f60c8b34 JG |
103 | extern struct bt_graph *bt_component_get_graph(struct bt_component *component); |
104 | ||
43de0e13 JG |
105 | #ifdef __cplusplus |
106 | } | |
107 | #endif | |
108 | ||
33b34c43 | 109 | #endif /* BABELTRACE_COMPONENT_COMPONENT_H */ |