1 #ifndef BABELTRACE_COMPONENT_COMPONENT_H
2 #define BABELTRACE_COMPONENT_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/component/component-class.h>
31 #include <babeltrace/component/notification/iterator.h>
32 #include <babeltrace/values.h>
39 struct bt_component_class
;
40 struct bt_component_graph
;
45 * Status code. Errors are always negative.
47 enum bt_component_status
{
48 /** No error, okay. */
49 BT_COMPONENT_STATUS_OK
= 0,
50 /** No more work to be done by this component. **/
51 BT_COMPONENT_STATUS_END
= 1,
53 * Component can't process a notification at this time
54 * (e.g. would block), try again later.
56 BT_COMPONENT_STATUS_AGAIN
= 2,
58 BT_COMPONENT_STATUS_ERROR
= -1,
59 /** Unsupported component feature. */
60 BT_COMPONENT_STATUS_UNSUPPORTED
= -2,
61 /** Invalid arguments. */
62 BT_COMPONENT_STATUS_INVALID
= -3,
63 /** Memory allocation failure. */
64 BT_COMPONENT_STATUS_NOMEM
= -4,
65 /** Element not found. */
66 BT_COMPONENT_STATUS_NOT_FOUND
= -5,
70 * Create an instance of a component from a component class.
72 * @param component_class Component class of which to create an instance
73 * @param name Name of the new component instance, optional
74 * @param params A dictionary of component parameters
75 * @returns Returns a pointer to a new component instance
77 extern struct bt_component
*bt_component_create(
78 struct bt_component_class
*component_class
, const char *name
,
79 struct bt_value
*params
);
81 extern struct bt_component
*bt_component_create_with_init_method_data(
82 struct bt_component_class
*component_class
, const char *name
,
83 struct bt_value
*params
, void *init_method_data
);
86 * Get a component's private data.
88 * @param component Component of which to get the private data
89 * @returns Component's private data
91 extern void *bt_component_get_private_data(struct bt_component
*component
);
94 * Set a component's private data.
96 * @param component Component of which to set the private data
97 * @param data Component private data
98 * @returns One of #bt_component_status values
100 extern enum bt_component_status
bt_component_set_private_data(
101 struct bt_component
*component
, void *data
);
104 * Get component's name.
106 * @param component Component instance of which to get the name
107 * @returns Returns a pointer to the component's name
109 extern const char *bt_component_get_name(struct bt_component
*component
);
112 * Get component's class.
114 * @param component Component instance of which to get the class
115 * @returns The component's class
117 extern struct bt_component_class
*bt_component_get_class(
118 struct bt_component
*component
);
120 extern enum bt_component_class_type
bt_component_get_class_type(
121 struct bt_component
*component
);
123 extern struct bt_graph
*bt_component_get_graph(struct bt_component
*component
);
129 #endif /* BABELTRACE_COMPONENT_COMPONENT_H */