1 #ifndef BABELTRACE_PLUGIN_COMPONENT_H
2 #define BABELTRACE_PLUGIN_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/plugin/component-class.h>
31 #include <babeltrace/values.h>
39 * Status code. Errors are always negative.
41 enum bt_component_status
{
42 /** Memory allocation failure. */
43 BT_COMPONENT_STATUS_NOMEM
= -4,
45 /** Invalid arguments. */
46 BT_COMPONENT_STATUS_INVAL
= -3,
48 /** Unsupported component feature. */
49 BT_COMPONENT_STATUS_UNSUPPORTED
= -2,
52 BT_COMPONENT_STATUS_ERROR
= -1,
54 /** No error, okay. */
55 BT_COMPONENT_STATUS_OK
= 0,
63 * Create an instance of a component from a component class.
65 * @param component_class Component class of which to create an instance
66 * @param name Name of the new component instance, optional
67 * @param params A dictionary of component parameters
68 * @returns Returns a pointer to a new component instance
70 extern struct bt_component
*bt_component_create(
71 struct bt_component_class
*component_class
, const char *name
,
72 struct bt_value
*params
);
75 * Get component's name.
77 * @param component Component instance of which to get the name
78 * @returns Returns a pointer to the component's name
80 extern const char *bt_component_get_name(struct bt_component
*component
);
83 * Set component's name.
85 * @param component Component instance of which to set the name
86 * @param name New component name (will be copied)
87 * @returns One of #bt_component_status values
89 extern enum bt_component_status
bt_component_set_name(
90 struct bt_component
*component
, const char *name
);
93 * Get component's class.
95 * @param component Component instance of which to get the class
96 * @returns The component's class
98 extern struct bt_component_class
*bt_component_get_class(
99 struct bt_component
*component
);
102 * Set component instance's error stream.
104 * @param component Component instance
105 * @param error_stream Error stream
106 * @returns One of #bt_component_status values
108 extern enum bt_component_status
bt_component_set_error_stream(
109 struct bt_component
*component
, FILE *error_stream
);
115 #endif /* BABELTRACE_PLUGIN_COMPONENT_H */