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 #include <babeltrace/graph/component-status.h>
31 #include <babeltrace/graph/component-class.h>
32 #include <babeltrace/graph/notification-iterator.h>
33 #include <babeltrace/values.h>
34 #include <babeltrace/types.h>
40 struct bt_component_class
;
41 struct bt_component_graph
;
47 * Create an instance of a component from a component class.
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
54 extern struct bt_component
*bt_component_create(
55 struct bt_component_class
*component_class
, const char *name
,
56 struct bt_value
*params
);
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
);
63 * Get component's name.
65 * @param component Component instance of which to get the name
66 * @returns Returns a pointer to the component's name
68 extern const char *bt_component_get_name(struct bt_component
*component
);
71 * Get component's class.
73 * @param component Component instance of which to get the class
74 * @returns The component's class
76 extern struct bt_component_class
*bt_component_get_class(
77 struct bt_component
*component
);
79 extern enum bt_component_class_type
bt_component_get_class_type(
80 struct bt_component
*component
);
83 bt_bool
bt_component_is_source(struct bt_component
*component
)
85 return bt_component_get_class_type(component
) ==
86 BT_COMPONENT_CLASS_TYPE_SOURCE
;
90 bt_bool
bt_component_is_filter(struct bt_component
*component
)
92 return bt_component_get_class_type(component
) ==
93 BT_COMPONENT_CLASS_TYPE_FILTER
;
97 bt_bool
bt_component_is_sink(struct bt_component
*component
)
99 return bt_component_get_class_type(component
) ==
100 BT_COMPONENT_CLASS_TYPE_SINK
;
103 extern struct bt_graph
*bt_component_get_graph(struct bt_component
*component
);
109 #endif /* BABELTRACE_GRAPH_COMPONENT_H */