projects / babeltrace.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
lib: graph API: remove "listener removed" callback parameters
[babeltrace.git] / include / babeltrace2 / graph / graph.h
diff --git a/include/babeltrace2/graph/graph.h b/include/babeltrace2/graph/graph.h
index d6bd7bad3bf815f89ca25121bc34c5a2b7a9406d..0a7484e475a854a9122e551fd9e32aa68824be57 100644 (file)
--- a/include/babeltrace2/graph/graph.h
+++ b/include/babeltrace2/graph/graph.h
@@ -1,9 +1,8 @@
-#ifndef BABELTRACE_GRAPH_GRAPH_H
-#define BABELTRACE_GRAPH_GRAPH_H
+#ifndef BABELTRACE2_GRAPH_GRAPH_H
+#define BABELTRACE2_GRAPH_GRAPH_H
 
 /*
- * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
- * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
+ * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -24,23 +23,13 @@
  * SOFTWARE.
  */
 
-/*
- * For bt_bool, bt_component, bt_component_class,
- * bt_component_class_filter, bt_component_class_sink,
- * bt_component_class_source, bt_component_filter, bt_component_sink,
- * bt_component_source, bt_connection, bt_graph, bt_port_input,
- * bt_port_output, bt_value
- */
-#include <babeltrace2/types.h>
+#ifndef __BT_IN_BABELTRACE_H
+# error "Please include <babeltrace2/babeltrace.h> instead."
+#endif
 
-/* For bt_logging_level */
+#include <babeltrace2/types.h>
 #include <babeltrace2/logging.h>
 
-/* For __BT_FUNC_STATUS_* */
-#define __BT_FUNC_STATUS_ENABLE
-#include <babeltrace2/func-status.h>
-#undef __BT_FUNC_STATUS_ENABLE
-
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -100,9 +89,33 @@ typedef bt_graph_listener_func_status
                const bt_port_output *upstream_port,
                const bt_port_input *downstream_port, void *data);
 
-typedef void (* bt_graph_listener_removed_func)(void *data);
+typedef enum bt_graph_simple_sink_component_initialize_func_status {
+       BT_GRAPH_SIMPLE_SINK_COMPONENT_INITIALIZE_FUNC_STATUS_OK                = __BT_FUNC_STATUS_OK,
+       BT_GRAPH_SIMPLE_SINK_COMPONENT_INITIALIZE_FUNC_STATUS_ERROR             = __BT_FUNC_STATUS_ERROR,
+       BT_GRAPH_SIMPLE_SINK_COMPONENT_INITIALIZE_FUNC_STATUS_MEMORY_ERROR      = __BT_FUNC_STATUS_MEMORY_ERROR,
+} bt_graph_simple_sink_component_initialize_func_status;
 
-extern bt_graph *bt_graph_create(void);
+typedef bt_graph_simple_sink_component_initialize_func_status
+(*bt_graph_simple_sink_component_initialize_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(uint64_t mip_version);
 
 typedef enum bt_graph_add_component_status {
        BT_GRAPH_ADD_COMPONENT_STATUS_OK                = __BT_FUNC_STATUS_OK,
@@ -117,7 +130,7 @@ bt_graph_add_source_component(bt_graph *graph,
                bt_logging_level log_level, const bt_component_source **component);
 
 extern bt_graph_add_component_status
-bt_graph_add_source_component_with_init_method_data(
+bt_graph_add_source_component_with_initialize_method_data(
                bt_graph *graph,
                const bt_component_class_source *component_class,
                const char *name, const bt_value *params,
@@ -132,7 +145,7 @@ bt_graph_add_filter_component(bt_graph *graph,
                const bt_component_filter **component);
 
 extern bt_graph_add_component_status
-bt_graph_add_filter_component_with_init_method_data(
+bt_graph_add_filter_component_with_initialize_method_data(
                bt_graph *graph,
                const bt_component_class_filter *component_class,
                const char *name, const bt_value *params,
@@ -147,16 +160,22 @@ bt_graph_add_sink_component(
                const bt_component_sink **component);
 
 extern bt_graph_add_component_status
-bt_graph_add_sink_component_with_init_method_data(
+bt_graph_add_sink_component_with_initialize_method_data(
                bt_graph *graph, const bt_component_class_sink *component_class,
                const char *name, const bt_value *params,
                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_initialize_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,
-       BT_GRAPH_CONNECT_PORTS_STATUS_CANCELED          = __BT_FUNC_STATUS_CANCELED,
        BT_GRAPH_CONNECT_PORTS_STATUS_MEMORY_ERROR      = __BT_FUNC_STATUS_MEMORY_ERROR,
 } bt_graph_connect_ports_status;
 
@@ -170,22 +189,19 @@ typedef enum bt_graph_run_status {
        BT_GRAPH_RUN_STATUS_ERROR               = __BT_FUNC_STATUS_ERROR,
        BT_GRAPH_RUN_STATUS_MEMORY_ERROR        = __BT_FUNC_STATUS_MEMORY_ERROR,
        BT_GRAPH_RUN_STATUS_AGAIN               = __BT_FUNC_STATUS_AGAIN,
-       BT_GRAPH_RUN_STATUS_END                 = __BT_FUNC_STATUS_END,
-       BT_GRAPH_RUN_STATUS_CANCELED            = __BT_FUNC_STATUS_CANCELED,
 } 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_CANCELED        = __BT_FUNC_STATUS_CANCELED,
-} 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,
@@ -196,68 +212,38 @@ extern bt_graph_add_listener_status
 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);
+               void *data, 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);
+               void *data, 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);
+               void *data, 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);
+               void *data, 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);
-
-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);
-
-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);
-
-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);
+typedef enum bt_graph_add_interrupter_status {
+       BT_GRAPH_ADD_INTERRUPTER_STATUS_OK              = __BT_FUNC_STATUS_OK,
+       BT_GRAPH_ADD_INTERRUPTER_STATUS_MEMORY_ERROR    = __BT_FUNC_STATUS_MEMORY_ERROR,
+} bt_graph_add_interrupter_status;
 
-typedef enum bt_graph_cancel_status {
-       BT_GRAPH_CANCEL_STATUS_OK       = __BT_FUNC_STATUS_OK,
-} bt_graph_cancel_status;
+extern bt_graph_add_interrupter_status bt_graph_add_interrupter(bt_graph *graph,
+               const bt_interrupter *interrupter);
 
-extern bt_graph_cancel_status bt_graph_cancel(bt_graph *graph);
+extern void bt_graph_interrupt(bt_graph *graph);
 
 #ifdef __cplusplus
 }
 #endif
 
-#include <babeltrace2/undef-func-status.h>
-
-#endif /* BABELTRACE_GRAPH_GRAPH_H */
+#endif /* BABELTRACE2_GRAPH_GRAPH_H */
BabelTrace - Trace Format Babel Tower
This page took 0.026309 seconds and 4 git commands to generate.