X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=include%2Fbabeltrace%2Fplugin%2Fplugin-system.h;h=ec84b872926bdc369c2d16ed43e504bf16774024;hb=fec2a9f220bdae0ce64716538c111348302f2696;hp=9a9332006a477b0e2345fb2ad9b44e71c59351d8;hpb=47e5a0329d01fa74bdf8b3fdcf75940f6789c93f;p=babeltrace.git

diff --git a/include/babeltrace/plugin/plugin-system.h b/include/babeltrace/plugin/plugin-system.h
index 9a933200..ec84b872 100644
--- a/include/babeltrace/plugin/plugin-system.h
+++ b/include/babeltrace/plugin/plugin-system.h
@@ -30,8 +30,8 @@
  * SOFTWARE.
  */
 
-#include <babeltrace/objects.h>
-#include <babeltrace/objects.h>
+#include <babeltrace/plugin/notification/notification.h>
+#include <stdint.h>
 
 #ifdef __cplusplus
 extern "C" {
@@ -40,6 +40,12 @@ extern "C" {
 struct bt_notification;
 struct bt_notification_iterator;
 struct bt_component;
+struct bt_component_factory;
+struct bt_value;
+
+typedef enum bt_component_status (*bt_plugin_init_func)(
+		struct bt_component_factory *factory);
+typedef void (*bt_plugin_exit_func)(void);
 
 /**
  * Component private data deallocation function type.
@@ -49,68 +55,214 @@ struct bt_component;
 typedef void (*bt_component_destroy_cb)(struct bt_component *component);
 
 /**
- * Iterator creation function type.
+ * Component initialization function type.
+ *
+ * A component's private data and required callbacks must be set by this
+ * function.
  *
  * @param component	Component instance
+ * @param params	A dictionary of component parameters
+ * @returns		One of #bt_component_status values
+ */
+typedef enum bt_component_status (*bt_component_init_cb)(
+		struct bt_component *component, struct bt_value *params);
+
+/**
+ * Get a component's private data.
+ *
+ * @param component	Component of which to get the private data
+ * @returns		Component's private data
  */
-typedef enum bt_component_status (*bt_component_source_iterator_init_cb)(
+extern void *bt_component_get_private_data(struct bt_component *component);
+
+/**
+ * Set a component's private data.
+ *
+ * @param component	Component of which to set the private data
+ * @param data		Component private data
+ * @returns		One of #bt_component_status values
+ */
+extern enum bt_component_status bt_component_set_private_data(
+		struct bt_component *component, void *data);
+
+/**
+ * Set a component's private data cleanup function.
+ *
+ * @param component	Component of which to set the private data destruction
+ *			function
+ * @param data		Component private data clean-up function
+ * @returns		One of #bt_component_status values
+ */
+extern enum bt_component_status bt_component_set_destroy_cb(
 		struct bt_component *component,
-		struct bt_notification_iterator *iterator);
+		bt_component_destroy_cb destroy);
 
-typedef struct bt_component *(*bt_component_init_cb)(
-		struct bt_component *component);
+/** bt_component_souce */
+/**
+ * Iterator initialization function type.
+ *
+ * A notification iterator's private data, deinitialization, next, and get
+ * callbacks must be set by this function.
+ *
+ * @param source	Source component instance
+ * @param iterator	Notification iterator instance
+ */
+typedef enum bt_component_status (*bt_component_source_init_iterator_cb)(
+		struct bt_component *, struct bt_notification_iterator *);
 
-typedef struct bt_component *(*bt_component_fini_cb)(
-		struct bt_component *component);
+/**
+ * Set a source component's iterator initialization function.
+ *
+ * @param source	Source component instance
+ * @param init_iterator	Notification iterator initialization callback
+ */
+extern enum bt_component_status
+bt_component_source_set_iterator_init_cb(struct bt_component *source,
+		bt_component_source_init_iterator_cb init_iterator);
 
+/** bt_component_sink */
 /**
- * Notification handling function type.
+ * Notification consumption function type.
  *
- * @param component	Component instance
- * @param notificattion	Notification to handle
+ * @param sink		Sink component instance
+ * @returns		One of #bt_component_status values
+ */
+typedef enum bt_component_status (*bt_component_sink_consume_cb)(
+		struct bt_component *);
+
+/**
+ * Iterator addition function type.
+ *
+ * A sink component may choose to refuse the addition of an iterator
+ * by not returning BT_COMPONENT_STATUS_OK.
+ *
+ * @param sink		Sink component instance
  * @returns		One of #bt_component_status values
  */
-typedef enum bt_component_status (*bt_component_sink_handle_notification_cb)(
-		struct bt_component *, struct bt_notification *);
+typedef enum bt_component_status (*bt_component_sink_add_iterator_cb)(
+		struct bt_component *, struct bt_notification_iterator *);
 
+/**
+ * Set a sink component's consumption callback.
+ *
+ * @param sink		Sink component instance
+ * @param consume	Consumption callback
+ * @returns		One of #bt_component_status values
+ */
+extern enum bt_component_status
+bt_component_sink_set_consume_cb(struct bt_component *sink,
+		bt_component_sink_consume_cb consume);
+
+/**
+ * Set a sink component's iterator addition callback.
+ *
+ * @param sink		Sink component instance
+ * @param add_iterator	Iterator addition callback
+ * @returns		One of #bt_component_status values
+ */
+extern enum bt_component_status
+bt_component_sink_set_add_iterator_cb(struct bt_component *sink,
+		bt_component_sink_add_iterator_cb add_iterator);
+
+/* Defaults to 1. */
+extern enum bt_component_status
+bt_component_sink_set_minimum_input_count(struct bt_component *sink,
+		unsigned int minimum);
+
+/* Defaults to 1. */
+extern enum bt_component_status
+bt_component_sink_set_maximum_input_count(struct bt_component *sink,
+		unsigned int maximum);
+
+extern enum bt_component_status
+bt_component_sink_get_input_count(struct bt_component *sink,
+		unsigned int *count);
+
+/* May return NULL after an interator has reached its end. */
+extern enum bt_component_status
+bt_component_sink_get_input_iterator(struct bt_component *sink,
+		unsigned int input, struct bt_notification_iterator **iterator);
+
+/** bt_notification_iterator */
+/**
+ * Function returning an iterator's current notification.
+ *
+ * @param iterator	Notification iterator instance
+ * @returns 		A notification instance
+ */
 typedef struct bt_notification *(*bt_notification_iterator_get_cb)(
-		struct bt_notification_iterator *);
+		struct bt_notification_iterator *iterator);
 
+/**
+ * Function advancing an iterator's position of one element.
+ *
+ * @param iterator	Notification iterator instance
+ * @returns 		One of #bt_notification_iterator_status values
+ */
 typedef enum bt_notification_iterator_status (*bt_notification_iterator_next_cb)(
-		struct bt_notification_iterator *);
+		struct bt_notification_iterator *iterator);
 
 /**
- * Get a component's private (implementation) data.
+ * Function cleaning-up an iterator's private data on destruction.
  *
- * @param component	Component of which to get the private data
- * @returns		Component's private data
+ * @param iterator	Notification iterator instance
  */
-extern void *bt_component_get_private_data(struct bt_component *component);
+typedef void (*bt_notification_iterator_destroy_cb)(
+		struct bt_notification_iterator *iterator);
 
+/**
+ * Set an iterator's "get" callback which return the current notification.
+ *
+ * @param iterator	Notification iterator instance
+ * @param get		Notification return callback
+ * @returns		One of #bt_notification_iterator_status values
+ */
 extern enum bt_notification_iterator_status
 bt_notification_iterator_set_get_cb(struct bt_notification_iterator *iterator,
 		bt_notification_iterator_get_cb get);
 
+/**
+ * Set an iterator's "next" callback which advances the iterator's position.
+ *
+ * @param iterator	Notification iterator instance
+ * @param next		Iterator "next" callback
+ * @returns		One of #bt_notification_iterator_status values
+ */
 extern enum bt_notification_iterator_status
 bt_notification_iterator_set_next_cb(struct bt_notification_iterator *iterator,
 		bt_notification_iterator_next_cb next);
 
+/**
+ * Set an iterator's "destroy" callback.
+ *
+ * @param iterator	Notification iterator instance
+ * @param next		Iterator destruction callback
+ * @returns		One of #bt_notification_iterator_status values
+ */
+extern enum bt_notification_iterator_status
+bt_notification_iterator_set_destroy_cb(
+		struct bt_notification_iterator *iterator,
+		bt_notification_iterator_destroy_cb destroy);
+
+/**
+ * Set an iterator's private data.
+ *
+ * @param iterator	Notification iterator instance
+ * @param data		Iterator private data
+ * @returns		One of #bt_notification_iterator_status values
+ */
 extern enum bt_notification_iterator_status
 bt_notification_iterator_set_private_data(
 		struct bt_notification_iterator *iterator, void *data);
 
-extern void *bt_notification_iterator_get_private_data(
-		struct bt_notification_iterator *iterator);
-
 /**
- * Set a component's private (implementation) data.
+ * Get an iterator's private data.
  *
- * @param component	Component of which to set the private data
- * @param data		Component private data
- * @returns		One of #bt_component_status values
+ * @param iterator	Notification iterator instance
+ * @returns		Iterator instance private data
  */
-extern enum bt_component_status bt_component_set_private_data(
-		struct bt_component *component, void *data);
+extern void *bt_notification_iterator_get_private_data(
+		struct bt_notification_iterator *iterator);
 
 #ifdef __cplusplus
 }