Avoid unnecessary inclusions in public headers
[babeltrace.git] / include / babeltrace / graph / graph.h
index c09279221c9f928115c65e917e484aa68ce20034..bb3d84cbd1322daca2686185b1723890c55ddb18 100644 (file)
@@ -1,5 +1,5 @@
-#ifndef BABELTRACE_COMPONENT_GRAPH_H
-#define BABELTRACE_COMPONENT_GRAPH_H
+#ifndef BABELTRACE_GRAPH_GRAPH_H
+#define BABELTRACE_GRAPH_GRAPH_H
 
 /*
  * BabelTrace - Babeltrace Graph Interface
@@ -27,7 +27,8 @@
  * SOFTWARE.
  */
 
-#include <babeltrace/graph/component.h>
+/* For bt_bool */
+#include <babeltrace/types.h>
 
 #ifdef __cplusplus
 extern "C" {
@@ -35,53 +36,63 @@ extern "C" {
 
 struct bt_port;
 struct bt_connection;
+struct bt_component;
+struct bt_component_class;
 
 enum bt_graph_status {
+       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 = 2,
+       BT_GRAPH_STATUS_AGAIN = 11,
        /** Downstream component does not support multiple inputs. */
        BT_GRAPH_STATUS_END = 1,
        BT_GRAPH_STATUS_OK = 0,
-       /** Downstream component does not support multiple inputs. */
-       BT_GRAPH_STATUS_MULTIPLE_INPUTS_UNSUPPORTED = -1,
-       /** Component is already part of another graph. */
-       BT_GRAPH_STATUS_ALREADY_IN_A_GRAPH = -2,
        /** Invalid arguments. */
-       BT_GRAPH_STATUS_INVALID = -3,
+       BT_GRAPH_STATUS_INVALID = -22,
        /** No sink in graph. */
-       BT_GRAPH_STATUS_NO_SINK = -4,
+       BT_GRAPH_STATUS_NO_SINK = -6,
        /** General error. */
-       BT_GRAPH_STATUS_ERROR = -5,
+       BT_GRAPH_STATUS_ERROR = -1,
+       BT_GRAPH_STATUS_CANNOT_CONSUME = -2,
+       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_port_connected_listener)(struct bt_port *port,
-               void *data);
-typedef void (*bt_graph_port_disconnected_listener)(
-               struct bt_component *component, struct bt_port *port,
+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 struct bt_connection *bt_graph_connect(struct bt_graph *graph,
-               struct bt_port *upstream,
-               struct bt_port *downstream);
-
-/**
- * Add a component as a "sibling" of the origin component. Sibling share
- * connections equivalent to each other at the time of connection (same
- * upstream and downstream ports).
- */
-extern enum bt_graph_status bt_graph_add_component_as_sibling(
-               struct bt_graph *graph, struct bt_component *origin,
-               struct bt_component *new_component);
+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.
@@ -98,24 +109,27 @@ extern enum bt_graph_status bt_graph_run(struct bt_graph *graph);
  */
 extern enum bt_graph_status bt_graph_consume(struct bt_graph *graph);
 
-extern enum bt_graph_status bt_graph_add_port_added_listener(
-               struct bt_graph *graph,
-               bt_graph_port_added_listener listener, void *data);
+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 enum bt_graph_status bt_graph_add_port_removed_listener(
-               struct bt_graph *graph,
-               bt_graph_port_removed_listener listener, 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 enum bt_graph_status bt_graph_add_port_connected_listener(
-               struct bt_graph *graph,
-               bt_graph_port_connected_listener listener, 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 enum bt_graph_status bt_graph_add_port_disconnected_listener(
-               struct bt_graph *graph,
-               bt_graph_port_disconnected_listener listener, 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
 }
 #endif
 
-#endif /* BABELTRACE_COMPONENT_GRAPH_H */
+#endif /* BABELTRACE_GRAPH_GRAPH_H */
This page took 0.024811 seconds and 4 git commands to generate.