Commit | Line | Data |
---|---|---|
584e4e78 JG |
1 | #ifndef BABELTRACE_PLUGIN_LIB_H |
2 | #define BABELTRACE_PLUGIN_LIB_H | |
3 | ||
4 | /* | |
5 | * BabelTrace - Base interface of a Babeltrace Plug-in Library | |
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 | ||
30 | #include <babeltrace/objects.h> | |
0db5ca2c | 31 | #include <babeltrace/plugin.h> |
584e4e78 JG |
32 | #include <stdint.h> |
33 | ||
34 | #ifdef __cplusplus | |
35 | extern "C" { | |
36 | #endif | |
37 | ||
38 | struct bt_plugin; | |
39 | struct bt_notification; | |
40 | ||
584e4e78 JG |
41 | /** |
42 | * Plug-in discovery functions. | |
43 | * | |
44 | * The Babeltrace plug-in architecture mandates that a given plug-in shared | |
45 | * object only define one plug-in. These functions are used to query a plug-in | |
46 | * shared object about its attributes. | |
47 | * | |
48 | * The functions marked as mandatory MUST be exported by the shared object | |
49 | * to be considered a valid plug-in. | |
50 | */ | |
7637fdf4 JG |
51 | |
52 | /** | |
53 | * Get the plug-in type implemented by the library. | |
54 | * | |
55 | * @returns One of #bt_plugin_type values | |
56 | */ | |
0db5ca2c | 57 | extern enum bt_plugin_type bt_plugin_lib_get_type(void); |
7637fdf4 JG |
58 | |
59 | /** | |
60 | * Get the name of the format implemented by the library. | |
61 | * | |
62 | * @returns A string (ownership is not transfered) | |
63 | */ | |
0db5ca2c | 64 | extern const char *bt_plugin_lib_get_format_name(void); |
584e4e78 JG |
65 | |
66 | /** | |
67 | * Create a plug-in instance configured with the provided parameters. | |
68 | * | |
69 | * @param params Map object of configuration parameters | |
7637fdf4 | 70 | * (see bt_object_map_create()) |
584e4e78 JG |
71 | * @returns An instance of the plug-in |
72 | */ | |
0db5ca2c | 73 | extern struct bt_plugin *bt_plugin_lib_create(struct bt_object *params); |
584e4e78 JG |
74 | |
75 | #ifdef __cplusplus | |
76 | } | |
77 | #endif | |
78 | ||
79 | #endif /* BABELTRACE_PLUGIN_H */ |