lib: add bt_{graph,query_executor}_add_interrupter()

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

diff --git a/include/babeltrace2/graph/graph.h b/include/babeltrace2/graph/graph.h
index 4b1909e83e5ced336593933dfba6fa0ddaf399de..46aebf9896a7cc82ab06d1274ce8e0369c1466b1 100644 (file)
--- a/include/babeltrace2/graph/graph.h
+++ b/include/babeltrace2/graph/graph.h
@@ -2,8 +2,7 @@
 #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
@@ -156,7 +145,6 @@ bt_graph_add_sink_component_with_init_method_data(
 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;
 
@@ -171,7 +159,6 @@ typedef enum bt_graph_run_status {
        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);
@@ -182,7 +169,6 @@ typedef enum bt_graph_consume_status {
        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;
 
 extern bt_graph_consume_status bt_graph_consume(bt_graph *graph);
@@ -248,16 +234,18 @@ bt_graph_add_filter_sink_component_ports_connected_listener(
                bt_graph_listener_removed_func listener_removed, void *data,
                int *listener_id);
 
-typedef enum bt_graph_cancel_status {
-       BT_GRAPH_CANCEL_STATUS_OK       = __BT_FUNC_STATUS_OK,
-} bt_graph_cancel_status;
+typedef enum bt_graph_add_interrupter_status {
+       BT_GRAPH_ADD_INTERRUPTER_STATUS_OK      = __BT_FUNC_STATUS_OK,
+       BT_GRAPH_ADD_INTERRUPTER_MEMORY_ERROR   = __BT_FUNC_STATUS_MEMORY_ERROR,
+} bt_graph_add_interrupter_status;
 
-extern bt_graph_cancel_status bt_graph_cancel(bt_graph *graph);
+extern bt_graph_add_interrupter_status bt_graph_add_interrupter(bt_graph *graph,
+               const bt_interrupter *interrupter);
+
+extern void bt_graph_interrupt(bt_graph *graph);
 
 #ifdef __cplusplus
 }
 #endif
 
-#include <babeltrace2/undef-func-status.h>
-
 #endif /* BABELTRACE2_GRAPH_GRAPH_H */