lib: graph: add "self" and some "private" APIs

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

diff --git a/include/babeltrace/graph/graph.h b/include/babeltrace/graph/graph.h
index f790e4496813c2a884d0605fdefb9b12c95142cc..440fe58b66222d56ae2efd132d21882d46e52031 100644 (file)
--- a/include/babeltrace/graph/graph.h
+++ b/include/babeltrace/graph/graph.h
@@ -2,8 +2,6 @@
 #define BABELTRACE_GRAPH_GRAPH_H
 
 /*
- * BabelTrace - Babeltrace Graph Interface
- *
  * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
@@ -27,102 +25,26 @@
  * SOFTWARE.
  */
 
-#include <babeltrace/graph/component.h>
+/* For bt_bool */
 #include <babeltrace/types.h>
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-struct bt_port;
-struct bt_connection;
+struct bt_graph;
 
 enum bt_graph_status {
+       BT_GRAPH_STATUS_OK = 0,
+       BT_GRAPH_STATUS_END = 1,
+       BT_GRAPH_STATUS_AGAIN = 11,
        BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION = 111,
-       /** Canceled. */
        BT_GRAPH_STATUS_CANCELED = 125,
-       /** No sink can consume at the moment. */
-       BT_GRAPH_STATUS_AGAIN = 11,
-       /** Downstream component does not support multiple inputs. */
-       BT_GRAPH_STATUS_END = 1,
-       BT_GRAPH_STATUS_OK = 0,
-       /** Invalid arguments. */
-       BT_GRAPH_STATUS_INVALID = -22,
-       /** No sink in graph. */
-       BT_GRAPH_STATUS_NO_SINK = -6,
-       /** General error. */
        BT_GRAPH_STATUS_ERROR = -1,
+       BT_GRAPH_STATUS_NO_SINK = -6,
        BT_GRAPH_STATUS_NOMEM = -12,
 };
 
-typedef void (*bt_graph_port_added_listener)(struct bt_port *port,
-               void *data);
-typedef void (*bt_graph_port_removed_listener)(struct bt_component *component,
-               struct bt_port *port, void *data);
-typedef void (*bt_graph_ports_connected_listener)(struct bt_port *upstream_port,
-               struct bt_port *downstream_port, void *data);
-typedef void (*bt_graph_ports_disconnected_listener)(
-               struct bt_component *upstream_component,
-               struct bt_component *downstream_component,
-               struct bt_port *upstream_port, struct bt_port *downstream_port,
-               void *data);
-typedef void (* bt_graph_listener_removed)(void *data);
-
-extern struct bt_graph *bt_graph_create(void);
-
-extern enum bt_graph_status bt_graph_add_component(
-               struct bt_graph *graph,
-               struct bt_component_class *component_class,
-               const char *name, struct bt_value *params,
-               struct bt_component **component);
-
-extern enum bt_graph_status bt_graph_add_component_with_init_method_data(
-               struct bt_graph *graph,
-               struct bt_component_class *component_class,
-               const char *name, struct bt_value *params,
-               void *init_method_data,
-               struct bt_component **component);
-
-/**
- * Creates a connection between two components using the two ports specified
- * and adds the connection and components (if not already added) to the graph.
- */
-extern enum bt_graph_status bt_graph_connect_ports(struct bt_graph *graph,
-               struct bt_port *upstream, struct bt_port *downstream,
-               struct bt_connection **connection);
-
-/**
- * Run graph to completion or until a single sink is left and "AGAIN" is received.
- *
- * Runs "bt_component_sink_consume()" on all sinks in round-robin until they all
- * indicate that the end is reached or that an error occured.
- */
-extern enum bt_graph_status bt_graph_run(struct bt_graph *graph);
-
-/**
- * Runs "bt_component_sink_consume()" on the graph's sinks. Each invokation will
- * invoke "bt_component_sink_consume()" on the next sink, in round-robin, until
- * they all indicated that the end is reached.
- */
-extern enum bt_graph_status bt_graph_consume(struct bt_graph *graph);
-
-extern int bt_graph_add_port_added_listener(struct bt_graph *graph,
-               bt_graph_port_added_listener listener,
-               bt_graph_listener_removed listener_removed, void *data);
-
-extern int bt_graph_add_port_removed_listener(struct bt_graph *graph,
-               bt_graph_port_removed_listener listener,
-               bt_graph_listener_removed listener_removed, void *data);
-
-extern int bt_graph_add_ports_connected_listener(struct bt_graph *graph,
-               bt_graph_ports_connected_listener listener,
-               bt_graph_listener_removed listener_removed, void *data);
-
-extern int bt_graph_add_ports_disconnected_listener(struct bt_graph *graph,
-               bt_graph_ports_disconnected_listener listener,
-               bt_graph_listener_removed listener_removed, void *data);
-
-extern enum bt_graph_status bt_graph_cancel(struct bt_graph *graph);
 extern bt_bool bt_graph_is_canceled(struct bt_graph *graph);
 
 #ifdef __cplusplus