1 #ifndef BABELTRACE2_GRAPH_COMPONENT_CONST_H
2 #define BABELTRACE2_GRAPH_COMPONENT_CONST_H
5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
6 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27 #ifndef __BT_IN_BABELTRACE_H
28 # error "Please include <babeltrace2/babeltrace.h> instead."
31 /* For bt_component_class_type */
32 #include <babeltrace2/graph/component-class-const.h>
35 * For bt_bool, bt_component_class, bt_component_graph, bt_component,
38 #include <babeltrace2/types.h>
40 /* For bt_logging_level */
41 #include <babeltrace2/logging.h>
48 * Get component's name.
50 * @param component Component instance of which to get the name
51 * @returns Returns a pointer to the component's name
53 extern const char *bt_component_get_name(const bt_component
*component
);
55 extern bt_logging_level
bt_component_get_logging_level(
56 const bt_component
*component
);
59 * Get component's class.
61 * @param component Component instance of which to get the class
62 * @returns The component's class
64 extern const bt_component_class
*bt_component_borrow_class_const(
65 const bt_component
*component
);
67 extern bt_component_class_type
bt_component_get_class_type(
68 const bt_component
*component
);
71 bt_bool
bt_component_is_source(const bt_component
*component
)
73 return bt_component_get_class_type(component
) ==
74 BT_COMPONENT_CLASS_TYPE_SOURCE
;
78 bt_bool
bt_component_is_filter(const bt_component
*component
)
80 return bt_component_get_class_type(component
) ==
81 BT_COMPONENT_CLASS_TYPE_FILTER
;
85 bt_bool
bt_component_is_sink(const bt_component
*component
)
87 return bt_component_get_class_type(component
) ==
88 BT_COMPONENT_CLASS_TYPE_SINK
;
91 extern bt_bool
bt_component_graph_is_canceled(
92 const bt_component
*component
);
94 extern void bt_component_get_ref(const bt_component
*component
);
96 extern void bt_component_put_ref(const bt_component
*component
);
98 #define BT_COMPONENT_PUT_REF_AND_RESET(_var) \
100 bt_component_put_ref(_var); \
104 #define BT_COMPONENT_MOVE_REF(_var_dst, _var_src) \
106 bt_component_put_ref(_var_dst); \
107 (_var_dst) = (_var_src); \
115 #endif /* BABELTRACE2_GRAPH_COMPONENT_CONST_H */