* SOFTWARE.
*/
-#include <babeltrace/objects.h>
-#include <babeltrace/objects.h>
+#include <babeltrace/plugin/notification/notification.h>
#ifdef __cplusplus
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.
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
+ */
+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
*/
-typedef enum bt_component_status (*bt_component_source_iterator_init_cb)(
+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.
*
- * @param component Component instance
- * @param notificattion Notification to handle
+ * A reference must be taken on the notification if the component has to
+ * keep ownership of the notification beyond the invocation of the callback.
+ *
+ * @param sink Sink component instance
+ * @param notification Notification to handle
* @returns One of #bt_component_status values
*/
typedef enum bt_component_status (*bt_component_sink_handle_notification_cb)(
struct bt_component *, struct bt_notification *);
+/**
+ * Set a sink component's notification handling callback.
+ *
+ * @param sink Sink component instance
+ * @param handle_notification Notification handling callback
+ * @returns One of #bt_component_status values
+ */
+extern enum bt_component_status
+bt_component_sink_set_handle_notification_cb(struct bt_component *sink,
+ bt_component_sink_handle_notification_cb handle_notification);
+
+/**
+ * Register a sink to a given notification type.
+ *
+ * A sink is always registered to notifications of type
+ * BT_NOTIFICATION_TYPE_EVENT. However, it may opt to receive any (or all)
+ * other notification type(s).
+ *
+ * @param sink Sink component instance.
+ * @param type One of #bt_notification_type
+ * @returns One of #bt_component_status
+ */
+extern enum bt_component_status
+bt_component_sink_register_notification_type(struct bt_component *sink,
+ enum bt_notification_type type);
+
+/** bt_component_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
}
projects / babeltrace.git / blobdiff