1 #ifndef BABELTRACE_COMPONENT_COMPONENT_CLASS_H
2 #define BABELTRACE_COMPONENT_COMPONENT_CLASS_H
5 * Babeltrace - Component Class Interface.
7 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
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:
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
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
28 #include <babeltrace/component/component.h>
35 struct bt_component_class
;
37 extern struct bt_component_class
*bt_component_class_create(
38 enum bt_component_type type
, const char *name
,
39 const char *description
, bt_component_init_cb init
);
42 * Get a component class' name.
44 * @param component_class Component class of which to get the name
45 * @returns Name of the component class
47 extern const char *bt_component_class_get_name(
48 struct bt_component_class
*component_class
);
51 * Get a component class' description.
53 * Component classes may provide an optional description. It may, however,
56 * @param component_class Component class of which to get the description
57 * @returns Description of the component class, or NULL.
59 extern const char *bt_component_class_get_description(
60 struct bt_component_class
*component_class
);
63 * Get a component class' type.
65 * @param component_class Component class of which to get the type
66 * @returns One of #bt_component_type
68 extern enum bt_component_type
bt_component_class_get_type(
69 struct bt_component_class
*component_class
);
71 #endif /* BABELTRACE_COMPONENT_COMPONENT_CLASS_H */