Commit | Line | Data |
---|---|---|
1ca80abd PP |
1 | #ifndef BABELTRACE_GRAPH_COMPONENT_H |
2 | #define BABELTRACE_GRAPH_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 | ||
e0831b38 | 30 | /* For BT_COMPONENT_CLASS_TYPE_* */ |
b2e0c907 | 31 | #include <babeltrace/graph/component-class.h> |
e0831b38 PP |
32 | |
33 | /* For bt_bool */ | |
c55a9f58 | 34 | #include <babeltrace/types.h> |
30d619df | 35 | |
f7c3ac09 PP |
36 | /* For bt_get */ |
37 | #include <babeltrace/ref.h> | |
38 | ||
43de0e13 JG |
39 | #ifdef __cplusplus |
40 | extern "C" { | |
41 | #endif | |
42 | ||
f60c8b34 JG |
43 | struct bt_component_class; |
44 | struct bt_component_graph; | |
45 | struct bt_component; | |
46 | struct bt_value; | |
72b913fb | 47 | struct bt_port; |
f60c8b34 | 48 | |
d97bac96 | 49 | /** |
33b34c43 | 50 | * Get component's name. |
d97bac96 | 51 | * |
33b34c43 PP |
52 | * @param component Component instance of which to get the name |
53 | * @returns Returns a pointer to the component's name | |
d97bac96 | 54 | */ |
33b34c43 | 55 | extern const char *bt_component_get_name(struct bt_component *component); |
8738a040 | 56 | |
d97bac96 | 57 | /** |
33b34c43 | 58 | * Get component's class. |
d97bac96 | 59 | * |
33b34c43 PP |
60 | * @param component Component instance of which to get the class |
61 | * @returns The component's class | |
d97bac96 | 62 | */ |
33b34c43 PP |
63 | extern struct bt_component_class *bt_component_get_class( |
64 | struct bt_component *component); | |
47e5a032 | 65 | |
d3e4dcd8 PP |
66 | extern enum bt_component_class_type bt_component_get_class_type( |
67 | struct bt_component *component); | |
68 | ||
543147fa | 69 | static inline |
c55a9f58 | 70 | bt_bool bt_component_is_source(struct bt_component *component) |
543147fa PP |
71 | { |
72 | return bt_component_get_class_type(component) == | |
73 | BT_COMPONENT_CLASS_TYPE_SOURCE; | |
74 | } | |
75 | ||
76 | static inline | |
c55a9f58 | 77 | bt_bool bt_component_is_filter(struct bt_component *component) |
543147fa PP |
78 | { |
79 | return bt_component_get_class_type(component) == | |
80 | BT_COMPONENT_CLASS_TYPE_FILTER; | |
81 | } | |
82 | ||
83 | static inline | |
c55a9f58 | 84 | bt_bool bt_component_is_sink(struct bt_component *component) |
543147fa PP |
85 | { |
86 | return bt_component_get_class_type(component) == | |
87 | BT_COMPONENT_CLASS_TYPE_SINK; | |
88 | } | |
89 | ||
f7c3ac09 PP |
90 | extern struct bt_graph *bt_component_borrow_graph(struct bt_component *component); |
91 | ||
92 | static inline | |
93 | struct bt_graph *bt_component_get_graph(struct bt_component *component) | |
94 | { | |
95 | return bt_get(bt_component_borrow_graph(component)); | |
96 | } | |
f60c8b34 | 97 | |
43de0e13 JG |
98 | #ifdef __cplusplus |
99 | } | |
100 | #endif | |
101 | ||
1ca80abd | 102 | #endif /* BABELTRACE_GRAPH_COMPONENT_H */ |