Commit | Line | Data |
---|---|---|
7b53201c PP |
1 | #ifndef BABELTRACE_GRAPH_COMPONENT_CONST_H |
2 | #define BABELTRACE_GRAPH_COMPONENT_CONST_H | |
43de0e13 JG |
3 | |
4 | /* | |
43de0e13 JG |
5 | * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
6 | * | |
7 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
8 | * | |
9 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
10 | * of this software and associated documentation files (the "Software"), to deal | |
11 | * in the Software without restriction, including without limitation the rights | |
12 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
13 | * copies of the Software, and to permit persons to whom the Software is | |
14 | * furnished to do so, subject to the following conditions: | |
15 | * | |
16 | * The above copyright notice and this permission notice shall be included in | |
17 | * all copies or substantial portions of the Software. | |
18 | * | |
19 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
20 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
21 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
22 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
23 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
24 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
25 | * SOFTWARE. | |
26 | */ | |
27 | ||
7b53201c PP |
28 | /* For enum bt_component_class_type */ |
29 | #include <babeltrace/graph/component-class-const.h> | |
e0831b38 PP |
30 | |
31 | /* For bt_bool */ | |
c55a9f58 | 32 | #include <babeltrace/types.h> |
30d619df | 33 | |
43de0e13 JG |
34 | #ifdef __cplusplus |
35 | extern "C" { | |
36 | #endif | |
37 | ||
f60c8b34 JG |
38 | struct bt_component_class; |
39 | struct bt_component_graph; | |
40 | struct bt_component; | |
41 | struct bt_value; | |
72b913fb | 42 | struct bt_port; |
f60c8b34 | 43 | |
d97bac96 | 44 | /** |
33b34c43 | 45 | * Get component's name. |
d97bac96 | 46 | * |
33b34c43 PP |
47 | * @param component Component instance of which to get the name |
48 | * @returns Returns a pointer to the component's name | |
d97bac96 | 49 | */ |
7b53201c | 50 | extern const char *bt_component_get_name(const struct bt_component *component); |
8738a040 | 51 | |
d97bac96 | 52 | /** |
33b34c43 | 53 | * Get component's class. |
d97bac96 | 54 | * |
33b34c43 PP |
55 | * @param component Component instance of which to get the class |
56 | * @returns The component's class | |
d97bac96 | 57 | */ |
7b53201c PP |
58 | extern const struct bt_component_class *bt_component_borrow_class_const( |
59 | const struct bt_component *component); | |
47e5a032 | 60 | |
d3e4dcd8 | 61 | extern enum bt_component_class_type bt_component_get_class_type( |
7b53201c | 62 | const struct bt_component *component); |
d3e4dcd8 | 63 | |
543147fa | 64 | static inline |
7b53201c | 65 | bt_bool bt_component_is_source(const struct bt_component *component) |
543147fa PP |
66 | { |
67 | return bt_component_get_class_type(component) == | |
68 | BT_COMPONENT_CLASS_TYPE_SOURCE; | |
69 | } | |
70 | ||
71 | static inline | |
7b53201c | 72 | bt_bool bt_component_is_filter(const struct bt_component *component) |
543147fa PP |
73 | { |
74 | return bt_component_get_class_type(component) == | |
75 | BT_COMPONENT_CLASS_TYPE_FILTER; | |
76 | } | |
77 | ||
78 | static inline | |
7b53201c | 79 | bt_bool bt_component_is_sink(const struct bt_component *component) |
543147fa PP |
80 | { |
81 | return bt_component_get_class_type(component) == | |
82 | BT_COMPONENT_CLASS_TYPE_SINK; | |
83 | } | |
84 | ||
7b53201c PP |
85 | extern bt_bool bt_component_graph_is_canceled( |
86 | const struct bt_component *component); | |
f60c8b34 | 87 | |
43de0e13 JG |
88 | #ifdef __cplusplus |
89 | } | |
90 | #endif | |
91 | ||
7b53201c | 92 | #endif /* BABELTRACE_GRAPH_COMPONENT_CONST_H */ |