remove extra line in reader
[babeltrace.git] / include / babeltrace / plugin / plugin.h
CommitLineData
90354d3a
JG
1#ifndef BABELTRACE_PLUGIN_H
2#define BABELTRACE_PLUGIN_H
3
4/*
584e4e78 5 * BabelTrace - Babeltrace Plug-in Interface
90354d3a
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
0db5ca2c
JG
30#include <errno.h>
31
90354d3a
JG
32#ifdef __cplusplus
33extern "C" {
34#endif
35
0db5ca2c
JG
36/**
37 * Plug-in type.
38 */
39enum bt_plugin_type {
40 BT_PLUGIN_TYPE_UNKNOWN = -1,
41
3f29fd91 42 /** A source plug-in is a notification generator. */
0db5ca2c
JG
43 BT_PLUGIN_TYPE_SOURCE = 0,
44
3f29fd91 45 /** A sink plug-in handles incoming notifications. */
0db5ca2c
JG
46 BT_PLUGIN_TYPE_SINK = 1,
47
3f29fd91 48 /** A filter plug-in implements both Source and Sink interfaces. */
0db5ca2c
JG
49 BT_PLUGIN_TYPE_FILTER = 2,
50};
51
52/**
53 * Status code. Errors are always negative.
54 */
55enum bt_plugin_status {
3f29fd91 56 /** Memory allocation failure. */
0db5ca2c
JG
57 /* -12 for compatibility with -ENOMEM */
58 BT_PLUGIN_STATUS_NOMEM = -12,
59
3f29fd91 60 /** Invalid arguments. */
0db5ca2c
JG
61 /* -22 for compatibility with -EINVAL */
62 BT_PLUGIN_STATUS_INVAL = -22,
63
3f29fd91 64 /** Unsupported plug-in feature. */
0db5ca2c
JG
65 BT_PLUGIN_STATUS_UNSUPPORTED = -2,
66
3f29fd91 67 /** General error. */
0db5ca2c
JG
68 BT_PLUGIN_STATUS_ERROR = -1,
69
3f29fd91 70 /** No error, okay. */
0db5ca2c
JG
71 BT_PLUGIN_STATUS_OK = 0,
72}
73
74/**
32bc5eed 75 * Get plug-in instance name.
0db5ca2c
JG
76 *
77 * @param plugin Plug-in instance of which to get the name
78 * @returns Returns a pointer to the plug-in's name
79 */
80extern const char *bt_plugin_get_name(struct bt_plugin *plugin);
81
82/**
32bc5eed 83 * Set plug-in instance name.
0db5ca2c
JG
84 *
85 * @param plugin Plug-in instance of which to set the name
86 * @param name New plug-in name (will be copied)
87 * @returns One of #bt_plugin_status values
88 */
89extern enum bt_plugin_status bt_plugin_set_name(
90 struct bt_plugin *plugin, const char *name);
91
92/**
32bc5eed 93 * Get plug-in instance type.
0db5ca2c
JG
94 *
95 * @param plugin Plug-in instance of which to get the type
96 * @returns One of #bt_plugin_type values
97 */
98extern enum bt_plugin_type bt_plugin_get_type(struct bt_plugin *plugin);
90354d3a 99
0db5ca2c 100/**
32bc5eed 101 * Set a plug-in instance's error stream.
0db5ca2c
JG
102 *
103 * @param plugin Plug-in instance
104 * @param error_stream Error stream
105 * @returns One of #bt_plugin_status values
106 */
107extern enum bt_plugin_status bt_plugin_set_error_stream(
108 struct bt_plugin *plugin, FILE *error_stream);
90354d3a 109
0db5ca2c
JG
110/**
111 * Increments the reference count of \p plugin.
112 *
113 * @param plugin Plug-in of which to increment the reference count
114 *
115 * @see bt_plugin_put()
116 */
117extern void bt_plugin_get(struct bt_plugin *plugin);
118
119/**
120 * Decrements the reference count of \p plugin, destroying it when this
121 * count reaches 0.
122 *
123 * @param plugin Plug-in of which to decrement the reference count
124 *
125 * @see bt_plugin_get()
126 */
127extern void bt_plugin_put(struct bt_plugin *plugin);
90354d3a
JG
128
129#ifdef __cplusplus
130}
131#endif
132
0db5ca2c 133#endif /* BABELTRACE_PLUGIN_H */
This page took 0.029011 seconds and 4 git commands to generate.