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
39 enum bt_component_type
{
40 BT_COMPONENT_TYPE_UNKNOWN
= -1,
42 /** A source component is a notification generator. */
43 BT_COMPONENT_TYPE_SOURCE
= 0,
45 /** A sink component handles incoming notifications. */
46 BT_COMPONENT_TYPE_SINK
= 1,
48 /** A filter component implements both Source and Sink interfaces. */
49 BT_COMPONENT_TYPE_FILTER
= 2,
53 * Status code. Errors are always negative.
55 enum bt_component_status
{
56 /** Memory allocation failure. */
57 /* -12 for compatibility with -ENOMEM */
58 BT_COMPONENT_STATUS_NOMEM
= -12,
60 /** Invalid arguments. */
61 /* -22 for compatibility with -EINVAL */
62 BT_COMPONENT_STATUS_INVAL
= -22,
64 /** Unsupported component feature. */
65 BT_COMPONENT_STATUS_UNSUPPORTED
= -2,
68 BT_COMPONENT_STATUS_ERROR
= -1,
70 /** No error, okay. */
71 BT_COMPONENT_STATUS_OK
= 0,
77 * Get component's name.
79 * @param component Component instance of which to get the name
80 * @returns Returns a pointer to the component's name
82 extern const char *bt_component_get_name(struct bt_component
*component
);
85 * Set component's name.
87 * @param component Component instance of which to set the name
88 * @param name New component name (will be copied)
89 * @returns One of #bt_component_status values
91 extern enum bt_component_status
bt_component_set_name(
92 struct bt_component
*component
, const char *name
);
95 * Get component instance type.
97 * @param component Component instance of which to get the type
98 * @returns One of #bt_component_type values
100 extern enum bt_component_type
bt_component_get_type(
101 struct bt_component
*component
);
104 * Set a component instance's error stream.
106 * @param component Component instance
107 * @param error_stream Error stream
108 * @returns One of #bt_component_status values
110 extern enum bt_component_status
bt_component_set_error_stream(
111 struct bt_component
*component
, FILE *error_stream
);
117 #endif /* BABELTRACE_PLUGIN_COMPONENT_H */