Component creation

[babeltrace.git] / include / babeltrace / plugin / plugin.h

diff --git a/include/babeltrace/plugin/plugin.h b/include/babeltrace/plugin/plugin.h
index a8aada4eb3eadf8884437154bd0ee116e192db7c..b522c91b7aec251e2ab7a80b1e93c2d6637e94cd 100644 (file)
--- a/include/babeltrace/plugin/plugin.h
+++ b/include/babeltrace/plugin/plugin.h
@@ -2,9 +2,9 @@
 #define BABELTRACE_PLUGIN_H
 
 /*
- * BabelTrace - Plug-in
+ * BabelTrace - Babeltrace Plug-in Interface
  *
- * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
+ * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
@@ -27,49 +27,35 @@
  * SOFTWARE.
  */
 
-#include <stdint.h>
-
 #ifdef __cplusplus
 extern "C" {
 #endif
 
 struct bt_plugin;
-struct bt_notification;
-
-enum bt_plugin_type {
-       BT_PLUGIN_TYPE_UNKNOWN = -1,
-       /* A source plug-in is a notification generator. */
-       BT_PLUGIN_TYPE_SOURCE = 0,
-       /* A sink plug-in handles incoming notifications. */
-       BT_PLUGIN_TYPE_SINK = 1,
-       /* A filter plug-in implements both SOURCE and SINK interfaces. */
-       BT_PLUGIN_TYPE_FILTER = 2,
-};
-
-typedef void (*bt_plugin_destroy_func)(struct bt_plugin *);
 
 /**
- * Plug-in discovery functions.
+ * Get the name of a plug-in.
  *
- * The Babeltrace plug-in architecture mandates that a given plug-in shared
- * object only define one plug-in. These functions are used to query a about
- * shared object about its attributes.
- *
- * The functions marked as mandatory MUST be exported by the shared object
- * to be considered a valid plug-in.
+ * @param plugin       An instance of a plug-in
+ * @returns            Plug-in name or NULL on error
  */
-/* Plug-in discovery functions... find a better name */
-enum bt_plugin_type bt_plugin_lib_get_type(void);
-const char *bt_plugin_lib_get_format_name(void);
+extern const char *bt_plugin_get_name(struct bt_plugin *plugin);
 
-/* TODO: document mandatory fields and their expected types */
-struct bt_plugin *bt_plugin_create(struct bt_ctf_field *params);
-void *bt_plugin_get_user_data(struct bt_plugin *plugin);
-int bt_plugin_set_error_stream(struct bt_plugin *plugin, FILE *error_stream);
+/**
+ * Get the name of a plug-in's author.
+ *
+ * @param plugin       An instance of a plug-in
+ * @returns            Plug-in author or NULL on error
+ */
+extern const char *bt_plugin_get_author(struct bt_plugin *plugin);
 
-/* Refcounting */
-void bt_plugin_get(struct bt_plugin *plugin);
-void bt_plugin_put(struct bt_plugin *plugin);
+/**
+ * Get the license of a plug-in.
+ *
+ * @param plugin       An instance of a plug-in
+ * @returns            Plug-in license or NULL on error
+ */
+extern const char *bt_plugin_get_license(struct bt_plugin *plugin);
 
 #ifdef __cplusplus
 }