Commit | Line | Data |
---|---|---|
62ed7c30 JG |
1 | #ifndef BABELTRACE_PLUGIN_COMPONENT_H |
2 | #define BABELTRACE_PLUGIN_COMPONENT_H | |
3 | ||
4 | /* | |
633edee0 | 5 | * BabelTrace - Babeltrace Component Interface |
62ed7c30 JG |
6 | * |
7 | * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
8 | * | |
9 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
10 | * | |
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: | |
17 | * | |
18 | * The above copyright notice and this permission notice shall be included in | |
19 | * all copies or substantial portions of the Software. | |
20 | * | |
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 | |
27 | * SOFTWARE. | |
28 | */ | |
29 | ||
fc11e32c | 30 | #include <babeltrace/plugin/component-class.h> |
62ed7c30 JG |
31 | #include <stdio.h> |
32 | ||
33 | #ifdef __cplusplus | |
34 | extern "C" { | |
35 | #endif | |
36 | ||
62ed7c30 JG |
37 | /** |
38 | * Status code. Errors are always negative. | |
39 | */ | |
40 | enum bt_component_status { | |
41 | /** Memory allocation failure. */ | |
fc11e32c | 42 | BT_COMPONENT_STATUS_NOMEM = -4, |
62ed7c30 JG |
43 | |
44 | /** Invalid arguments. */ | |
fc11e32c | 45 | BT_COMPONENT_STATUS_INVAL = -3, |
62ed7c30 JG |
46 | |
47 | /** Unsupported component feature. */ | |
48 | BT_COMPONENT_STATUS_UNSUPPORTED = -2, | |
49 | ||
50 | /** General error. */ | |
51 | BT_COMPONENT_STATUS_ERROR = -1, | |
52 | ||
53 | /** No error, okay. */ | |
54 | BT_COMPONENT_STATUS_OK = 0, | |
55 | }; | |
56 | ||
57 | struct bt_component; | |
58 | ||
38b48196 JG |
59 | |
60 | /** | |
61 | * Create an instance of a component from a component class. | |
62 | * | |
63 | * @param component_class Component class of which to create an instance | |
64 | * @param name Name of the new component instance, optional | |
65 | * @returns Returns a pointer to a new component instance | |
66 | */ | |
67 | extern struct bt_component *bt_component_create( | |
68 | struct bt_component_class *component_class, const char *name); | |
69 | ||
62ed7c30 JG |
70 | /** |
71 | * Get component's name. | |
72 | * | |
73 | * @param component Component instance of which to get the name | |
633edee0 | 74 | * @returns Returns a pointer to the component's name |
62ed7c30 JG |
75 | */ |
76 | extern const char *bt_component_get_name(struct bt_component *component); | |
77 | ||
78 | /** | |
79 | * Set component's name. | |
80 | * | |
81 | * @param component Component instance of which to set the name | |
633edee0 | 82 | * @param name New component name (will be copied) |
62ed7c30 JG |
83 | * @returns One of #bt_component_status values |
84 | */ | |
85 | extern enum bt_component_status bt_component_set_name( | |
86 | struct bt_component *component, const char *name); | |
87 | ||
88 | /** | |
fc11e32c | 89 | * Get component's class. |
62ed7c30 | 90 | * |
fc11e32c JG |
91 | * @param component Component instance of which to get the class |
92 | * @returns The component's class | |
62ed7c30 | 93 | */ |
fc11e32c | 94 | extern struct bt_component_class *bt_component_get_class( |
62ed7c30 JG |
95 | struct bt_component *component); |
96 | ||
97 | /** | |
fc11e32c | 98 | * Set component instance's error stream. |
62ed7c30 JG |
99 | * |
100 | * @param component Component instance | |
101 | * @param error_stream Error stream | |
102 | * @returns One of #bt_component_status values | |
103 | */ | |
104 | extern enum bt_component_status bt_component_set_error_stream( | |
105 | struct bt_component *component, FILE *error_stream); | |
106 | ||
62ed7c30 JG |
107 | #ifdef __cplusplus |
108 | } | |
109 | #endif | |
110 | ||
111 | #endif /* BABELTRACE_PLUGIN_COMPONENT_H */ |