#define BABELTRACE_GRAPH_GRAPH_H
/*
- * BabelTrace - Babeltrace Graph Interface
- *
+ * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
* Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
*
- * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
- *
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* SOFTWARE.
*/
-/* For bt_bool */
+/*
+ * 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 <babeltrace/types.h>
+/* For bt_graph_status */
+#include <babeltrace/graph/graph-const.h>
+
#ifdef __cplusplus
extern "C" {
#endif
-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 = 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_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_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,
+typedef enum bt_graph_listener_status {
+ BT_GRAPH_LISTENER_STATUS_OK = 0,
+ BT_GRAPH_LISTENER_STATUS_ERROR = -1,
+ BT_GRAPH_LISTENER_STATUS_NOMEM = -12,
+} bt_graph_listener_status;
+
+typedef bt_graph_listener_status
+(*bt_graph_filter_component_input_port_added_listener_func)(
+ const bt_component_filter *component,
+ const bt_port_input *port, void *data);
+
+typedef bt_graph_listener_status
+(*bt_graph_sink_component_input_port_added_listener_func)(
+ const bt_component_sink *component,
+ const bt_port_input *port, void *data);
+
+typedef bt_graph_listener_status
+(*bt_graph_source_component_output_port_added_listener_func)(
+ const bt_component_source *component,
+ const bt_port_output *port, void *data);
+
+typedef bt_graph_listener_status
+(*bt_graph_filter_component_output_port_added_listener_func)(
+ const bt_component_filter *component,
+ const bt_port_output *port, void *data);
+
+typedef bt_graph_listener_status
+(*bt_graph_source_filter_component_ports_connected_listener_func)(
+ const bt_component_source *source_component,
+ const bt_component_filter *filter_component,
+ const bt_port_output *upstream_port,
+ const bt_port_input *downstream_port, void *data);
+
+typedef bt_graph_listener_status
+(*bt_graph_source_sink_component_ports_connected_listener_func)(
+ const bt_component_source *source_component,
+ const bt_component_sink *sink_component,
+ const bt_port_output *upstream_port,
+ const bt_port_input *downstream_port, void *data);
+
+typedef bt_graph_listener_status
+(*bt_graph_filter_filter_component_ports_connected_listener_func)(
+ const bt_component_filter *filter_component_upstream,
+ const bt_component_filter *filter_component_downstream,
+ const bt_port_output *upstream_port,
+ const bt_port_input *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);
+typedef bt_graph_listener_status
+(*bt_graph_filter_sink_component_ports_connected_listener_func)(
+ const bt_component_filter *filter_component,
+ const bt_component_sink *sink_component,
+ const bt_port_output *upstream_port,
+ const bt_port_input *downstream_port, void *data);
-/**
- * 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);
+typedef void (* bt_graph_listener_removed_func)(void *data);
-/**
- * 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);
+extern bt_graph *bt_graph_create(void);
-/**
- * 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 bt_graph_status bt_graph_add_source_component(bt_graph *graph,
+ const bt_component_class_source *component_class,
+ const char *name, const bt_value *params,
+ const bt_component_source **component);
-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 bt_graph_status bt_graph_add_source_component_with_init_method_data(
+ bt_graph *graph,
+ const bt_component_class_source *component_class,
+ const char *name, const bt_value *params,
+ void *init_method_data,
+ const bt_component_source **component);
-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 bt_graph_status bt_graph_add_filter_component(bt_graph *graph,
+ const bt_component_class_filter *component_class,
+ const char *name, const bt_value *params,
+ const bt_component_filter **component);
-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 bt_graph_status bt_graph_add_filter_component_with_init_method_data(
+ bt_graph *graph,
+ const bt_component_class_filter *component_class,
+ const char *name, const bt_value *params,
+ void *init_method_data,
+ const bt_component_filter **component);
-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 bt_graph_status bt_graph_add_sink_component(
+ bt_graph *graph, const bt_component_class_sink *component_class,
+ const char *name, const bt_value *params,
+ const bt_component_sink **component);
-extern enum bt_graph_status bt_graph_cancel(struct bt_graph *graph);
-extern bt_bool bt_graph_is_canceled(struct bt_graph *graph);
+extern bt_graph_status bt_graph_add_sink_component_with_init_method_data(
+ bt_graph *graph, const bt_component_class_sink *component_class,
+ const char *name, const bt_value *params,
+ void *init_method_data,
+ const bt_component_sink **component);
+
+extern bt_graph_status bt_graph_connect_ports(bt_graph *graph,
+ const bt_port_output *upstream,
+ const bt_port_input *downstream,
+ const bt_connection **connection);
+
+extern bt_graph_status bt_graph_run(bt_graph *graph);
+
+extern bt_graph_status bt_graph_consume(bt_graph *graph);
+
+extern bt_graph_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);
+
+extern bt_graph_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);
+
+extern bt_graph_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);
+
+extern bt_graph_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);
+
+extern bt_graph_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_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_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_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);
+
+extern bt_graph_status bt_graph_cancel(bt_graph *graph);
#ifdef __cplusplus
}
projects / babeltrace.git / blobdiff