lib: update copyrights
[babeltrace.git] / include / babeltrace / graph / graph.h
index f44bee7f3c12328ae0f3557781daeeacdc1c3ab8..029bfda2142cddf5ad66d93f62b886bc0717030c 100644 (file)
@@ -2,10 +2,9 @@
 #define BABELTRACE_GRAPH_GRAPH_H
 
 /*
+ * 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
 /* For bt_bool */
 #include <babeltrace/types.h>
 
-/* For enum bt_component_status */
-#include <babeltrace/graph/component-status.h>
+/* For enum bt_graph_status */
+#include <babeltrace/graph/graph-const.h>
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
+struct bt_component;
+struct bt_component_class;
+struct bt_component_class_filter;
+struct bt_component_class_sink;
+struct bt_component_class_source;
+struct bt_component_filter;
+struct bt_component_sink;
+struct bt_component_source;
+struct bt_connection;
 struct bt_graph;
+struct bt_port_input;
+struct bt_port_output;
+struct bt_value;
+
+typedef void (*bt_graph_filter_component_input_port_added_listener_func)(
+               const struct bt_component_filter *component,
+               const struct bt_port_input *port, void *data);
+
+typedef void (*bt_graph_sink_component_input_port_added_listener_func)(
+               const struct bt_component_sink *component,
+               const struct bt_port_input *port, void *data);
+
+typedef void (*bt_graph_source_component_output_port_added_listener_func)(
+               const struct bt_component_source *component,
+               const struct bt_port_output *port, void *data);
+
+typedef void (*bt_graph_filter_component_output_port_added_listener_func)(
+               const struct bt_component_filter *component,
+               const struct bt_port_output *port, void *data);
+
+typedef void (*bt_graph_filter_component_input_port_removed_listener_func)(
+               const struct bt_component_filter *component,
+               const struct bt_port_input *port, void *data);
+
+typedef void (*bt_graph_sink_component_input_port_removed_listener_func)(
+               const struct bt_component_sink *component,
+               const struct bt_port_input *port, void *data);
+
+typedef void (*bt_graph_source_component_output_port_removed_listener_func)(
+               const struct bt_component_source *component,
+               const struct bt_port_output *port, void *data);
+
+typedef void (*bt_graph_filter_component_output_port_removed_listener_func)(
+               const struct bt_component_filter *component,
+               const struct bt_port_output *port, void *data);
+
+typedef void (*bt_graph_source_filter_component_ports_connected_listener_func)(
+               const struct bt_component_source *source_component,
+               const struct bt_component_filter *filter_component,
+               const struct bt_port_output *upstream_port,
+               const struct bt_port_input *downstream_port, void *data);
+
+typedef void (*bt_graph_source_sink_component_ports_connected_listener_func)(
+               const struct bt_component_source *source_component,
+               const struct bt_component_sink *sink_component,
+               const struct bt_port_output *upstream_port,
+               const struct bt_port_input *downstream_port, void *data);
+
+typedef void (*bt_graph_filter_sink_component_ports_connected_listener_func)(
+               const struct bt_component_filter *filter_component,
+               const struct bt_component_sink *sink_component,
+               const struct bt_port_output *upstream_port,
+               const struct bt_port_input *downstream_port, void *data);
+
+typedef void (*bt_graph_source_filter_component_ports_disconnected_listener_func)(
+               const struct bt_component_source *source_component,
+               const struct bt_component_filter *filter_component,
+               const struct bt_port_output *upstream_port,
+               const struct bt_port_input *downstream_port,
+               void *data);
+
+typedef void (*bt_graph_source_sink_component_ports_disconnected_listener_func)(
+               const struct bt_component_source *source_component,
+               const struct bt_component_sink *sink_component,
+               const struct bt_port_output *upstream_port,
+               const struct bt_port_input *downstream_port,
+               void *data);
+
+typedef void (*bt_graph_filter_sink_component_ports_disconnected_listener_func)(
+               const struct bt_component_filter *filter_component,
+               const struct bt_component_sink *sink_component,
+               const struct bt_port_output *upstream_port,
+               const struct bt_port_input *downstream_port,
+               void *data);
+
+typedef void (* bt_graph_listener_removed_func)(void *data);
+
+extern struct bt_graph *bt_graph_create(void);
+
+extern enum bt_graph_status bt_graph_add_source_component(
+               struct bt_graph *graph,
+               const struct bt_component_class_source *component_class,
+               const char *name, const struct bt_value *params,
+               const struct bt_component_source **component);
+
+extern enum bt_graph_status
+bt_graph_add_source_component_with_init_method_data(
+               struct bt_graph *graph,
+               const struct bt_component_class_source *component_class,
+               const char *name, const struct bt_value *params,
+               void *init_method_data,
+               const struct bt_component_source **component);
+
+extern enum bt_graph_status bt_graph_add_filter_component(
+               struct bt_graph *graph,
+               const struct bt_component_class_filter *component_class,
+               const char *name, const struct bt_value *params,
+               const struct bt_component_filter **component);
+
+extern enum bt_graph_status
+bt_graph_add_filter_component_with_init_method_data(
+               struct bt_graph *graph,
+               const struct bt_component_class_filter *component_class,
+               const char *name, const struct bt_value *params,
+               void *init_method_data,
+               const struct bt_component_filter **component);
+
+extern enum bt_graph_status bt_graph_add_sink_component(
+               struct bt_graph *graph,
+               const struct bt_component_class_sink *component_class,
+               const char *name, const struct bt_value *params,
+               const struct bt_component_sink **component);
+
+extern enum bt_graph_status
+bt_graph_add_sink_component_with_init_method_data(
+               struct bt_graph *graph,
+               const struct bt_component_class_sink *component_class,
+               const char *name, const struct bt_value *params,
+               void *init_method_data,
+               const struct bt_component_sink **component);
+
+extern enum bt_graph_status bt_graph_connect_ports(
+               struct bt_graph *graph,
+               const struct bt_port_output *upstream,
+               const struct bt_port_input *downstream,
+               const struct bt_connection **connection);
+
+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_filter_component_input_port_added_listener(
+               struct 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 enum bt_graph_status
+bt_graph_add_sink_component_input_port_added_listener(
+               struct 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 enum bt_graph_status
+bt_graph_add_source_component_output_port_added_listener(
+               struct 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 enum bt_graph_status
+bt_graph_add_filter_component_output_port_added_listener(
+               struct 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 enum bt_graph_status
+bt_graph_add_filter_component_input_port_removed_listener(
+               struct bt_graph *graph,
+               bt_graph_filter_component_input_port_removed_listener_func listener,
+               bt_graph_listener_removed_func listener_removed, void *data,
+               int *listener_id);
+
+extern enum bt_graph_status
+bt_graph_add_sink_component_input_port_removed_listener(
+               struct bt_graph *graph,
+               bt_graph_sink_component_input_port_removed_listener_func listener,
+               bt_graph_listener_removed_func listener_removed, void *data,
+               int *listener_id);
+
+extern enum bt_graph_status
+bt_graph_add_source_component_output_port_removed_listener(
+               struct bt_graph *graph,
+               bt_graph_source_component_output_port_removed_listener_func listener,
+               bt_graph_listener_removed_func listener_removed, void *data,
+               int *listener_id);
+
+extern enum bt_graph_status
+bt_graph_add_filter_component_output_port_removed_listener(
+               struct bt_graph *graph,
+               bt_graph_filter_component_output_port_removed_listener_func listener,
+               bt_graph_listener_removed_func listener_removed, void *data,
+               int *listener_id);
+
+extern enum bt_graph_status
+bt_graph_add_source_filter_component_ports_connected_listener(
+               struct 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 enum bt_graph_status
+bt_graph_add_source_sink_component_ports_connected_listener(
+               struct 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 enum bt_graph_status
+bt_graph_add_filter_sink_component_ports_connected_listener(
+               struct 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 enum bt_graph_status
+bt_graph_add_source_filter_component_ports_disconnected_listener(
+               struct bt_graph *graph,
+               bt_graph_source_filter_component_ports_disconnected_listener_func listener,
+               bt_graph_listener_removed_func listener_removed, void *data,
+               int *listener_id);
+
+extern enum bt_graph_status
+bt_graph_add_source_sink_component_ports_disconnected_listener(
+               struct bt_graph *graph,
+               bt_graph_source_sink_component_ports_disconnected_listener_func listener,
+               bt_graph_listener_removed_func listener_removed, void *data,
+               int *listener_id);
+
+extern enum bt_graph_status
+bt_graph_add_filter_sink_component_ports_disconnected_listener(
+               struct bt_graph *graph,
+               bt_graph_filter_sink_component_ports_disconnected_listener_func listener,
+               bt_graph_listener_removed_func listener_removed, void *data,
+               int *listener_id);
 
-enum bt_graph_status {
-       BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION = 111,
-       /** Canceled. */
-       BT_GRAPH_STATUS_CANCELED = BT_COMPONENT_STATUS_GRAPH_IS_CANCELED,
-       /** No sink can consume at the moment. */
-       BT_GRAPH_STATUS_AGAIN = BT_COMPONENT_STATUS_AGAIN,
-       /** Downstream component does not support multiple inputs. */
-       BT_GRAPH_STATUS_END = BT_COMPONENT_STATUS_END,
-       BT_GRAPH_STATUS_OK = BT_COMPONENT_STATUS_OK,
-       /** Invalid arguments. */
-       BT_GRAPH_STATUS_INVALID = BT_COMPONENT_STATUS_INVALID,
-       /** No sink in graph. */
-       BT_GRAPH_STATUS_NO_SINK = -6,
-       /** General error. */
-       BT_GRAPH_STATUS_ERROR = BT_COMPONENT_STATUS_ERROR,
-       BT_GRAPH_STATUS_NOMEM = BT_COMPONENT_STATUS_NOMEM,
-};
-
-extern bt_bool bt_graph_is_canceled(struct bt_graph *graph);
+extern enum bt_graph_status bt_graph_cancel(struct bt_graph *graph);
 
 #ifdef __cplusplus
 }
This page took 0.026161 seconds and 4 git commands to generate.