1 #ifndef BABELTRACE_GRAPH_COMPONENT_H
2 #define BABELTRACE_GRAPH_COMPONENT_H
5 * BabelTrace - Babeltrace Component Interface
7 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
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:
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
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
30 /* For BT_COMPONENT_CLASS_TYPE_* */
31 #include <babeltrace/graph/component-class.h>
34 #include <babeltrace/types.h>
36 /* For bt_object_get_ref */
37 #include <babeltrace/object.h>
43 struct bt_component_class
;
44 struct bt_component_graph
;
50 * Get component's name.
52 * @param component Component instance of which to get the name
53 * @returns Returns a pointer to the component's name
55 extern const char *bt_component_get_name(struct bt_component
*component
);
58 * Get component's class.
60 * @param component Component instance of which to get the class
61 * @returns The component's class
63 extern struct bt_component_class
*bt_component_get_class(
64 struct bt_component
*component
);
66 extern enum bt_component_class_type
bt_component_get_class_type(
67 struct bt_component
*component
);
70 bt_bool
bt_component_is_source(struct bt_component
*component
)
72 return bt_component_get_class_type(component
) ==
73 BT_COMPONENT_CLASS_TYPE_SOURCE
;
77 bt_bool
bt_component_is_filter(struct bt_component
*component
)
79 return bt_component_get_class_type(component
) ==
80 BT_COMPONENT_CLASS_TYPE_FILTER
;
84 bt_bool
bt_component_is_sink(struct bt_component
*component
)
86 return bt_component_get_class_type(component
) ==
87 BT_COMPONENT_CLASS_TYPE_SINK
;
90 extern bt_bool
bt_component_graph_is_canceled(struct bt_component
*component
);
96 #endif /* BABELTRACE_GRAPH_COMPONENT_H */