include/babeltrace/plugin/plugin.h

   1 #ifndef BABELTRACE_PLUGIN_H
   2 #define BABELTRACE_PLUGIN_H
   3
   4 /*
   5  * BabelTrace - Babeltrace Plug-in Interface
   6  *
   7  * Copyright 2016 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 #ifdef __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 struct bt_plugin;
  35
  36 /**
  37  * Get the name of a plug-in.
  38  *
  39  * @param plugin        An instance of a plug-in
  40  * @returns             Plug-in name or NULL on error
  41  */
  42 extern const char *bt_plugin_get_name(struct bt_plugin *plugin);
  43
  44 /**
  45  * Get the name of a plug-in's author.
  46  *
  47  * @param plugin        An instance of a plug-in
  48  * @returns             Plug-in author or NULL on error
  49  */
  50 extern const char *bt_plugin_get_author(struct bt_plugin *plugin);
  51
  52 /**
  53  * Get the license of a plug-in.
  54  *
  55  * @param plugin        An instance of a plug-in
  56  * @returns             Plug-in license or NULL on error
  57  */
  58 extern const char *bt_plugin_get_license(struct bt_plugin *plugin);
  59
  60 /**
  61  * Get the decription of a plug-in.
  62  *
  63  * @param plugin        An instance of a plug-in
  64  * @returns             Plug-in description or NULL if none is available
  65  */
  66 extern const char *bt_plugin_get_description(struct bt_plugin *plugin);
  67
  68 /**
  69  * Get the path of a plug-in.
  70  *
  71  * @param plugin        An instance of a plug-in
  72  * @returns             Plug-in path or NULL on error
  73  */
  74 extern const char *bt_plugin_get_path(struct bt_plugin *plugin);
  75
  76 #ifdef __cplusplus
  77 }
  78 #endif
  79
  80 #endif /* BABELTRACE_PLUGIN_H */