include/babeltrace/graph/graph.h

   1 #ifndef BABELTRACE_GRAPH_GRAPH_H
   2 #define BABELTRACE_GRAPH_GRAPH_H
   3
   4 /*
   5  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   6  * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a copy
   9  * of this software and associated documentation files (the "Software"), to deal
  10  * in the Software without restriction, including without limitation the rights
  11  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12  * copies of the Software, and to permit persons to whom the Software is
  13  * furnished to do so, subject to the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included in
  16  * all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  24  * SOFTWARE.
  25  */
  26
  27 /*
  28  * For bt_bool, bt_component, bt_component_class,
  29  * bt_component_class_filter, bt_component_class_sink,
  30  * bt_component_class_source, bt_component_filter, bt_component_sink,
  31  * bt_component_source, bt_connection, bt_graph, bt_port_input,
  32  * bt_port_output, bt_value
  33  */
  34 #include <babeltrace/types.h>
  35
  36 /* For bt_graph_status */
  37 #include <babeltrace/graph/graph-const.h>
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 typedef enum bt_graph_listener_status {
  44         BT_GRAPH_LISTENER_STATUS_OK = 0,
  45         BT_GRAPH_LISTENER_STATUS_ERROR = -1,
  46         BT_GRAPH_LISTENER_STATUS_NOMEM = -12,
  47 } bt_graph_listener_status;
  48
  49 typedef bt_graph_listener_status
  50 (*bt_graph_filter_component_input_port_added_listener_func)(
  51                 const bt_component_filter *component,
  52                 const bt_port_input *port, void *data);
  53
  54 typedef bt_graph_listener_status
  55 (*bt_graph_sink_component_input_port_added_listener_func)(
  56                 const bt_component_sink *component,
  57                 const bt_port_input *port, void *data);
  58
  59 typedef bt_graph_listener_status
  60 (*bt_graph_source_component_output_port_added_listener_func)(
  61                 const bt_component_source *component,
  62                 const bt_port_output *port, void *data);
  63
  64 typedef bt_graph_listener_status
  65 (*bt_graph_filter_component_output_port_added_listener_func)(
  66                 const bt_component_filter *component,
  67                 const bt_port_output *port, void *data);
  68
  69 typedef bt_graph_listener_status
  70 (*bt_graph_source_filter_component_ports_connected_listener_func)(
  71                 const bt_component_source *source_component,
  72                 const bt_component_filter *filter_component,
  73                 const bt_port_output *upstream_port,
  74                 const bt_port_input *downstream_port, void *data);
  75
  76 typedef bt_graph_listener_status
  77 (*bt_graph_source_sink_component_ports_connected_listener_func)(
  78                 const bt_component_source *source_component,
  79                 const bt_component_sink *sink_component,
  80                 const bt_port_output *upstream_port,
  81                 const bt_port_input *downstream_port, void *data);
  82
  83 typedef bt_graph_listener_status
  84 (*bt_graph_filter_filter_component_ports_connected_listener_func)(
  85                 const bt_component_filter *filter_component_upstream,
  86                 const bt_component_filter *filter_component_downstream,
  87                 const bt_port_output *upstream_port,
  88                 const bt_port_input *downstream_port,
  89                 void *data);
  90
  91 typedef bt_graph_listener_status
  92 (*bt_graph_filter_sink_component_ports_connected_listener_func)(
  93                 const bt_component_filter *filter_component,
  94                 const bt_component_sink *sink_component,
  95                 const bt_port_output *upstream_port,
  96                 const bt_port_input *downstream_port, void *data);
  97
  98 typedef void (* bt_graph_listener_removed_func)(void *data);
  99
 100 extern bt_graph *bt_graph_create(void);
 101
 102 extern bt_graph_status bt_graph_add_source_component(bt_graph *graph,
 103                 const bt_component_class_source *component_class,
 104                 const char *name, const bt_value *params,
 105                 const bt_component_source **component);
 106
 107 extern bt_graph_status bt_graph_add_source_component_with_init_method_data(
 108                 bt_graph *graph,
 109                 const bt_component_class_source *component_class,
 110                 const char *name, const bt_value *params,
 111                 void *init_method_data,
 112                 const bt_component_source **component);
 113
 114 extern bt_graph_status bt_graph_add_filter_component(bt_graph *graph,
 115                 const bt_component_class_filter *component_class,
 116                 const char *name, const bt_value *params,
 117                 const bt_component_filter **component);
 118
 119 extern bt_graph_status bt_graph_add_filter_component_with_init_method_data(
 120                 bt_graph *graph,
 121                 const bt_component_class_filter *component_class,
 122                 const char *name, const bt_value *params,
 123                 void *init_method_data,
 124                 const bt_component_filter **component);
 125
 126 extern bt_graph_status bt_graph_add_sink_component(
 127                 bt_graph *graph, const bt_component_class_sink *component_class,
 128                 const char *name, const bt_value *params,
 129                 const bt_component_sink **component);
 130
 131 extern bt_graph_status bt_graph_add_sink_component_with_init_method_data(
 132                 bt_graph *graph, const bt_component_class_sink *component_class,
 133                 const char *name, const bt_value *params,
 134                 void *init_method_data,
 135                 const bt_component_sink **component);
 136
 137 extern bt_graph_status bt_graph_connect_ports(bt_graph *graph,
 138                 const bt_port_output *upstream,
 139                 const bt_port_input *downstream,
 140                 const bt_connection **connection);
 141
 142 extern bt_graph_status bt_graph_run(bt_graph *graph);
 143
 144 extern bt_graph_status bt_graph_consume(bt_graph *graph);
 145
 146 extern bt_graph_status bt_graph_add_filter_component_input_port_added_listener(
 147                 bt_graph *graph,
 148                 bt_graph_filter_component_input_port_added_listener_func listener,
 149                 bt_graph_listener_removed_func listener_removed, void *data,
 150                 int *listener_id);
 151
 152 extern bt_graph_status bt_graph_add_sink_component_input_port_added_listener(
 153                 bt_graph *graph,
 154                 bt_graph_sink_component_input_port_added_listener_func listener,
 155                 bt_graph_listener_removed_func listener_removed, void *data,
 156                 int *listener_id);
 157
 158 extern bt_graph_status bt_graph_add_source_component_output_port_added_listener(
 159                 bt_graph *graph,
 160                 bt_graph_source_component_output_port_added_listener_func listener,
 161                 bt_graph_listener_removed_func listener_removed, void *data,
 162                 int *listener_id);
 163
 164 extern bt_graph_status bt_graph_add_filter_component_output_port_added_listener(
 165                 bt_graph *graph,
 166                 bt_graph_filter_component_output_port_added_listener_func listener,
 167                 bt_graph_listener_removed_func listener_removed, void *data,
 168                 int *listener_id);
 169
 170 extern bt_graph_status
 171 bt_graph_add_source_filter_component_ports_connected_listener(
 172                 bt_graph *graph,
 173                 bt_graph_source_filter_component_ports_connected_listener_func listener,
 174                 bt_graph_listener_removed_func listener_removed, void *data,
 175                 int *listener_id);
 176
 177 extern bt_graph_status
 178 bt_graph_add_filter_filter_component_ports_connected_listener(
 179                 bt_graph *graph,
 180                 bt_graph_filter_filter_component_ports_connected_listener_func listener,
 181                 bt_graph_listener_removed_func listener_removed, void *data,
 182                 int *listener_id);
 183
 184 extern bt_graph_status
 185 bt_graph_add_source_sink_component_ports_connected_listener(
 186                 bt_graph *graph,
 187                 bt_graph_source_sink_component_ports_connected_listener_func listener,
 188                 bt_graph_listener_removed_func listener_removed, void *data,
 189                 int *listener_id);
 190
 191 extern bt_graph_status
 192 bt_graph_add_filter_sink_component_ports_connected_listener(
 193                 bt_graph *graph,
 194                 bt_graph_filter_sink_component_ports_connected_listener_func listener,
 195                 bt_graph_listener_removed_func listener_removed, void *data,
 196                 int *listener_id);
 197
 198 extern bt_graph_status bt_graph_cancel(bt_graph *graph);
 199
 200 #ifdef __cplusplus
 201 }
 202 #endif
 203
 204 #endif /* BABELTRACE_GRAPH_GRAPH_H */