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> |
f3bc2010 | 31 | #include <babeltrace/values.h> |
62ed7c30 JG |
32 | #include <stdio.h> |
33 | ||
34 | #ifdef __cplusplus | |
35 | extern "C" { | |
36 | #endif | |
37 | ||
62ed7c30 JG |
38 | /** |
39 | * Status code. Errors are always negative. | |
40 | */ | |
41 | enum bt_component_status { | |
42 | /** Memory allocation failure. */ | |
fc11e32c | 43 | BT_COMPONENT_STATUS_NOMEM = -4, |
62ed7c30 JG |
44 | |
45 | /** Invalid arguments. */ | |
fc11e32c | 46 | BT_COMPONENT_STATUS_INVAL = -3, |
62ed7c30 JG |
47 | |
48 | /** Unsupported component feature. */ | |
49 | BT_COMPONENT_STATUS_UNSUPPORTED = -2, | |
50 | ||
51 | /** General error. */ | |
52 | BT_COMPONENT_STATUS_ERROR = -1, | |
53 | ||
54 | /** No error, okay. */ | |
55 | BT_COMPONENT_STATUS_OK = 0, | |
56 | }; | |
57 | ||
62ed7c30 | 58 | |
7c7c0433 JG |
59 | struct bt_component; |
60 | struct bt_value; | |
38b48196 JG |
61 | |
62 | /** | |
63 | * Create an instance of a component from a component class. | |
64 | * | |
65 | * @param component_class Component class of which to create an instance | |
66 | * @param name Name of the new component instance, optional | |
7c7c0433 | 67 | * @param params A dictionary of component parameters |
38b48196 JG |
68 | * @returns Returns a pointer to a new component instance |
69 | */ | |
70 | extern struct bt_component *bt_component_create( | |
7c7c0433 JG |
71 | struct bt_component_class *component_class, const char *name, |
72 | struct bt_value *params); | |
38b48196 | 73 | |
62ed7c30 JG |
74 | /** |
75 | * Get component's name. | |
76 | * | |
77 | * @param component Component instance of which to get the name | |
633edee0 | 78 | * @returns Returns a pointer to the component's name |
62ed7c30 JG |
79 | */ |
80 | extern const char *bt_component_get_name(struct bt_component *component); | |
81 | ||
82 | /** | |
83 | * Set component's name. | |
84 | * | |
85 | * @param component Component instance of which to set the name | |
633edee0 | 86 | * @param name New component name (will be copied) |
62ed7c30 JG |
87 | * @returns One of #bt_component_status values |
88 | */ | |
89 | extern enum bt_component_status bt_component_set_name( | |
90 | struct bt_component *component, const char *name); | |
91 | ||
92 | /** | |
fc11e32c | 93 | * Get component's class. |
62ed7c30 | 94 | * |
fc11e32c JG |
95 | * @param component Component instance of which to get the class |
96 | * @returns The component's class | |
62ed7c30 | 97 | */ |
fc11e32c | 98 | extern struct bt_component_class *bt_component_get_class( |
62ed7c30 JG |
99 | struct bt_component *component); |
100 | ||
101 | /** | |
fc11e32c | 102 | * Set component instance's error stream. |
62ed7c30 JG |
103 | * |
104 | * @param component Component instance | |
105 | * @param error_stream Error stream | |
106 | * @returns One of #bt_component_status values | |
107 | */ | |
108 | extern enum bt_component_status bt_component_set_error_stream( | |
109 | struct bt_component *component, FILE *error_stream); | |
110 | ||
62ed7c30 JG |
111 | #ifdef __cplusplus |
112 | } | |
113 | #endif | |
114 | ||
115 | #endif /* BABELTRACE_PLUGIN_COMPONENT_H */ |