lib: add bt_graph_add_simple_sink_component()

[babeltrace.git] / include / babeltrace2 / graph / graph.h

diff --git a/include/babeltrace2/graph/graph.h b/include/babeltrace2/graph/graph.h
index 46aebf9896a7cc82ab06d1274ce8e0369c1466b1..06e3dc44c86c53d7489589fd145039240525b20d 100644 (file)
--- a/include/babeltrace2/graph/graph.h
+++ b/include/babeltrace2/graph/graph.h
@@ -91,6 +91,32 @@ typedef bt_graph_listener_func_status
 
 typedef void (* bt_graph_listener_removed_func)(void *data);
 
+typedef enum bt_graph_simple_sink_component_init_func_status {
+       BT_GRAPH_SIMPLE_SINK_COMPONENT_INIT_FUNC_STATUS_OK              = __BT_FUNC_STATUS_OK,
+       BT_GRAPH_SIMPLE_SINK_COMPONENT_INIT_FUNC_STATUS_ERROR           = __BT_FUNC_STATUS_ERROR,
+       BT_GRAPH_SIMPLE_SINK_COMPONENT_INIT_FUNC_STATUS_MEMORY_ERROR    = __BT_FUNC_STATUS_MEMORY_ERROR,
+} bt_graph_simple_sink_component_init_func_status;
+
+typedef bt_graph_simple_sink_component_init_func_status
+(*bt_graph_simple_sink_component_init_func)(
+               bt_self_component_port_input_message_iterator *iterator,
+               void *data);
+
+typedef enum bt_graph_simple_sink_component_consume_func_status {
+       BT_GRAPH_SIMPLE_SINK_COMPONENT_CONSUME_FUNC_STATUS_OK                   = __BT_FUNC_STATUS_OK,
+       BT_GRAPH_SIMPLE_SINK_COMPONENT_CONSUME_FUNC_STATUS_ERROR                = __BT_FUNC_STATUS_ERROR,
+       BT_GRAPH_SIMPLE_SINK_COMPONENT_CONSUME_FUNC_STATUS_MEMORY_ERROR =       __BT_FUNC_STATUS_MEMORY_ERROR,
+       BT_GRAPH_SIMPLE_SINK_COMPONENT_CONSUME_FUNC_STATUS_AGAIN                = __BT_FUNC_STATUS_AGAIN,
+       BT_GRAPH_SIMPLE_SINK_COMPONENT_CONSUME_FUNC_STATUS_END                  = __BT_FUNC_STATUS_END,
+} bt_graph_simple_sink_component_consume_func_status;
+
+typedef bt_graph_simple_sink_component_consume_func_status
+(*bt_graph_simple_sink_component_consume_func)(
+               bt_self_component_port_input_message_iterator *iterator,
+               void *data);
+
+typedef void (*bt_graph_simple_sink_component_finalize_func)(void *data);
+
 extern bt_graph *bt_graph_create(void);
 
 typedef enum bt_graph_add_component_status {
@@ -142,6 +168,13 @@ bt_graph_add_sink_component_with_init_method_data(
                void *init_method_data, bt_logging_level log_level,
                const bt_component_sink **component);
 
+extern bt_graph_add_component_status
+bt_graph_add_simple_sink_component(bt_graph *graph, const char *name,
+               bt_graph_simple_sink_component_init_func init_func,
+               bt_graph_simple_sink_component_consume_func consume_func,
+               bt_graph_simple_sink_component_finalize_func finalize_func,
+               void *user_data, const bt_component_sink **component);
+
 typedef enum bt_graph_connect_ports_status {
        BT_GRAPH_CONNECT_PORTS_STATUS_OK                = __BT_FUNC_STATUS_OK,
        BT_GRAPH_CONNECT_PORTS_STATUS_ERROR             = __BT_FUNC_STATUS_ERROR,
@@ -163,15 +196,15 @@ typedef enum bt_graph_run_status {
 
 extern bt_graph_run_status bt_graph_run(bt_graph *graph);
 
-typedef enum bt_graph_consume_status {
-       BT_GRAPH_CONSUME_STATUS_OK              = __BT_FUNC_STATUS_OK,
-       BT_GRAPH_CONSUME_STATUS_ERROR           = __BT_FUNC_STATUS_ERROR,
-       BT_GRAPH_CONSUME_STATUS_MEMORY_ERROR    = __BT_FUNC_STATUS_MEMORY_ERROR,
-       BT_GRAPH_CONSUME_STATUS_AGAIN           = __BT_FUNC_STATUS_AGAIN,
-       BT_GRAPH_CONSUME_STATUS_END             = __BT_FUNC_STATUS_END,
-} bt_graph_consume_status;
+typedef enum bt_graph_run_once_status {
+       BT_GRAPH_RUN_ONCE_STATUS_OK             = __BT_FUNC_STATUS_OK,
+       BT_GRAPH_RUN_ONCE_STATUS_ERROR          = __BT_FUNC_STATUS_ERROR,
+       BT_GRAPH_RUN_ONCE_STATUS_MEMORY_ERROR   = __BT_FUNC_STATUS_MEMORY_ERROR,
+       BT_GRAPH_RUN_ONCE_STATUS_AGAIN          = __BT_FUNC_STATUS_AGAIN,
+       BT_GRAPH_RUN_ONCE_STATUS_END            = __BT_FUNC_STATUS_END,
+} bt_graph_run_once_status;
 
-extern bt_graph_consume_status bt_graph_consume(bt_graph *graph);
+extern bt_graph_run_once_status bt_graph_run_once(bt_graph *graph);
 
 typedef enum bt_graph_add_listener_status {
        BT_GRAPH_ADD_LISTENER_STATUS_OK                 = __BT_FUNC_STATUS_OK,
@@ -183,56 +216,56 @@ bt_graph_add_filter_component_input_port_added_listener(
                bt_graph *graph,
                bt_graph_filter_component_input_port_added_listener_func listener,
                bt_graph_listener_removed_func listener_removed, void *data,
-               int *listener_id);
+               bt_listener_id *listener_id);
 
 extern bt_graph_add_listener_status
 bt_graph_add_sink_component_input_port_added_listener(
                bt_graph *graph,
                bt_graph_sink_component_input_port_added_listener_func listener,
                bt_graph_listener_removed_func listener_removed, void *data,
-               int *listener_id);
+               bt_listener_id *listener_id);
 
 extern bt_graph_add_listener_status
 bt_graph_add_source_component_output_port_added_listener(
                bt_graph *graph,
                bt_graph_source_component_output_port_added_listener_func listener,
                bt_graph_listener_removed_func listener_removed, void *data,
-               int *listener_id);
+               bt_listener_id *listener_id);
 
 extern bt_graph_add_listener_status
 bt_graph_add_filter_component_output_port_added_listener(
                bt_graph *graph,
                bt_graph_filter_component_output_port_added_listener_func listener,
                bt_graph_listener_removed_func listener_removed, void *data,
-               int *listener_id);
+               bt_listener_id *listener_id);
 
 extern bt_graph_add_listener_status
 bt_graph_add_source_filter_component_ports_connected_listener(
                bt_graph *graph,
                bt_graph_source_filter_component_ports_connected_listener_func listener,
                bt_graph_listener_removed_func listener_removed, void *data,
-               int *listener_id);
+               bt_listener_id *listener_id);
 
 extern bt_graph_add_listener_status
 bt_graph_add_filter_filter_component_ports_connected_listener(
                bt_graph *graph,
                bt_graph_filter_filter_component_ports_connected_listener_func listener,
                bt_graph_listener_removed_func listener_removed, void *data,
-               int *listener_id);
+               bt_listener_id *listener_id);
 
 extern bt_graph_add_listener_status
 bt_graph_add_source_sink_component_ports_connected_listener(
                bt_graph *graph,
                bt_graph_source_sink_component_ports_connected_listener_func listener,
                bt_graph_listener_removed_func listener_removed, void *data,
-               int *listener_id);
+               bt_listener_id *listener_id);
 
 extern bt_graph_add_listener_status
 bt_graph_add_filter_sink_component_ports_connected_listener(
                bt_graph *graph,
                bt_graph_filter_sink_component_ports_connected_listener_func listener,
                bt_graph_listener_removed_func listener_removed, void *data,
-               int *listener_id);
+               bt_listener_id *listener_id);
 
 typedef enum bt_graph_add_interrupter_status {
        BT_GRAPH_ADD_INTERRUPTER_STATUS_OK      = __BT_FUNC_STATUS_OK,