Commit | Line | Data |
---|---|---|
fc11e32c JG |
1 | #ifndef BABELTRACE_PLUGIN_COMPONENT_CLASS_H |
2 | #define BABELTRACE_PLUGIN_COMPONENT_CLASS_H | |
3 | ||
4 | /* | |
5 | * Babeltrace - Component Class Interface. | |
6 | * | |
7 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
8 | * | |
9 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
10 | * of this software and associated documentation files (the "Software"), to deal | |
11 | * in the Software without restriction, including without limitation the rights | |
12 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
13 | * copies of the Software, and to permit persons to whom the Software is | |
14 | * furnished to do so, subject to the following conditions: | |
15 | * | |
16 | * The above copyright notice and this permission notice shall be included in | |
17 | * all copies or substantial portions of the Software. | |
18 | * | |
19 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
20 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
21 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
22 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
23 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
24 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
25 | * SOFTWARE. | |
26 | */ | |
27 | ||
28 | #ifdef __cplusplus | |
29 | extern "C" { | |
30 | #endif | |
31 | ||
32 | /** | |
33 | * Component type. | |
34 | */ | |
35 | enum bt_component_type { | |
36 | BT_COMPONENT_TYPE_UNKNOWN = -1, | |
37 | ||
38 | /** A source component is a notification generator. */ | |
39 | BT_COMPONENT_TYPE_SOURCE = 0, | |
40 | ||
41 | /** A sink component handles incoming notifications. */ | |
42 | BT_COMPONENT_TYPE_SINK = 1, | |
43 | ||
44 | /** A filter component implements both Source and Sink interfaces. */ | |
45 | BT_COMPONENT_TYPE_FILTER = 2, | |
46 | }; | |
47 | ||
38b48196 | 48 | struct bt_plugin; |
fc11e32c JG |
49 | struct bt_component_class; |
50 | ||
38b48196 JG |
51 | |
52 | /** | |
53 | * Get a component class' name. | |
54 | * | |
55 | * @param component_class Component class of which to get the name | |
56 | * @returns Name of the component class | |
57 | */ | |
58 | extern const char *bt_component_class_get_name( | |
59 | struct bt_component_class *component_class); | |
60 | ||
61 | /** | |
62 | * Get a component class' type. | |
63 | * | |
64 | * @param component_class Component class of which to get the type | |
65 | * @returns One of #bt_component_type | |
66 | */ | |
67 | extern enum bt_component_type bt_component_class_get_type( | |
fc11e32c JG |
68 | struct bt_component_class *component_class); |
69 | ||
38b48196 JG |
70 | /** |
71 | * Get a component class' plug-in. | |
72 | * | |
73 | * @param component_class Component class of which to get the plug-in | |
74 | * @returns The plug-in which registered the component class | |
75 | */ | |
76 | extern struct bt_plugin *bt_component_class_get_plugin( | |
fc11e32c JG |
77 | struct bt_component_class *component_class); |
78 | ||
79 | #endif /* BABELTRACE_PLUGIN_COMPONENT_CLASS_H */ |