8bafd263ba6ec8949e840f849779269ff2d34e5d
[babeltrace.git] / include / babeltrace / plugin / plugin-lib.h
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>
31 #include <stdint.h>
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 struct bt_plugin;
38 struct bt_notification;
39
40 enum bt_plugin_type {
41 BT_PLUGIN_TYPE_UNKNOWN = -1,
42 /* A source plug-in is a notification generator. */
43 BT_PLUGIN_TYPE_SOURCE = 0,
44 /* A sink plug-in handles incoming notifications. */
45 BT_PLUGIN_TYPE_SINK = 1,
46 /* A filter plug-in implements both SOURCE and SINK interfaces. */
47 BT_PLUGIN_TYPE_FILTER = 2,
48 };
49
50 /**
51 * Plug-in discovery functions.
52 *
53 * The Babeltrace plug-in architecture mandates that a given plug-in shared
54 * object only define one plug-in. These functions are used to query a plug-in
55 * shared object about its attributes.
56 *
57 * The functions marked as mandatory MUST be exported by the shared object
58 * to be considered a valid plug-in.
59 */
60 enum bt_plugin_type bt_plugin_lib_get_type(void);
61 const char *bt_plugin_lib_get_format_name(void);
62
63 /**
64 * Create a plug-in instance configured with the provided parameters.
65 *
66 * @param params Map object of configuration parameters
67 * @returns An instance of the plug-in
68 */
69 struct bt_plugin *bt_plugin_lib_create(struct bt_object *params);
70
71 #ifdef __cplusplus
72 }
73 #endif
74
75 #endif /* BABELTRACE_PLUGIN_H */
This page took 0.031659 seconds and 3 git commands to generate.