Rename "default beginning/end CS" -> "beginning/end default CS"
[babeltrace.git] / include / babeltrace / graph / graph.h
CommitLineData
1ca80abd
PP
1#ifndef BABELTRACE_GRAPH_GRAPH_H
2#define BABELTRACE_GRAPH_GRAPH_H
c0418dd9
JG
3
4/*
e2f7325d 5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
f60c8b34 6 * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
c0418dd9 7 *
c0418dd9
JG
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
b19ff26f
PP
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 */
202a3a13 34#include <babeltrace/types.h>
c0418dd9 35
4cdfc5e8 36/* For bt_graph_status */
0d72b8c3
PP
37#include <babeltrace/graph/graph-const.h>
38
c0418dd9
JG
39#ifdef __cplusplus
40extern "C" {
41#endif
42
8cc56726
SM
43typedef 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
49typedef bt_graph_listener_status
50(*bt_graph_filter_component_input_port_added_listener_func)(
b19ff26f
PP
51 const bt_component_filter *component,
52 const bt_port_input *port, void *data);
0d72b8c3 53
8cc56726
SM
54typedef bt_graph_listener_status
55(*bt_graph_sink_component_input_port_added_listener_func)(
b19ff26f
PP
56 const bt_component_sink *component,
57 const bt_port_input *port, void *data);
0d72b8c3 58
8cc56726
SM
59typedef bt_graph_listener_status
60(*bt_graph_source_component_output_port_added_listener_func)(
b19ff26f
PP
61 const bt_component_source *component,
62 const bt_port_output *port, void *data);
0d72b8c3 63
8cc56726
SM
64typedef bt_graph_listener_status
65(*bt_graph_filter_component_output_port_added_listener_func)(
b19ff26f
PP
66 const bt_component_filter *component,
67 const bt_port_output *port, void *data);
0d72b8c3 68
8cc56726
SM
69typedef bt_graph_listener_status
70(*bt_graph_source_filter_component_ports_connected_listener_func)(
b19ff26f
PP
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);
0d72b8c3 75
8cc56726
SM
76typedef bt_graph_listener_status
77(*bt_graph_source_sink_component_ports_connected_listener_func)(
b19ff26f
PP
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);
0d72b8c3 82
8cc56726
SM
83typedef bt_graph_listener_status
84(*bt_graph_filter_filter_component_ports_connected_listener_func)(
9c0a126a
PP
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
8cc56726
SM
91typedef bt_graph_listener_status
92(*bt_graph_filter_sink_component_ports_connected_listener_func)(
b19ff26f
PP
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);
0d72b8c3 97
0d72b8c3
PP
98typedef void (* bt_graph_listener_removed_func)(void *data);
99
b19ff26f 100extern bt_graph *bt_graph_create(void);
0d72b8c3 101
4cdfc5e8 102extern bt_graph_status bt_graph_add_source_component(bt_graph *graph,
b19ff26f
PP
103 const bt_component_class_source *component_class,
104 const char *name, const bt_value *params,
105 const bt_component_source **component);
0d72b8c3 106
4cdfc5e8 107extern bt_graph_status bt_graph_add_source_component_with_init_method_data(
b19ff26f
PP
108 bt_graph *graph,
109 const bt_component_class_source *component_class,
110 const char *name, const bt_value *params,
0d72b8c3 111 void *init_method_data,
b19ff26f 112 const bt_component_source **component);
0d72b8c3 113
4cdfc5e8 114extern bt_graph_status bt_graph_add_filter_component(bt_graph *graph,
b19ff26f
PP
115 const bt_component_class_filter *component_class,
116 const char *name, const bt_value *params,
117 const bt_component_filter **component);
0d72b8c3 118
4cdfc5e8 119extern bt_graph_status bt_graph_add_filter_component_with_init_method_data(
b19ff26f
PP
120 bt_graph *graph,
121 const bt_component_class_filter *component_class,
122 const char *name, const bt_value *params,
0d72b8c3 123 void *init_method_data,
b19ff26f 124 const bt_component_filter **component);
0d72b8c3 125
4cdfc5e8
PP
126extern bt_graph_status bt_graph_add_sink_component(
127 bt_graph *graph, const bt_component_class_sink *component_class,
b19ff26f
PP
128 const char *name, const bt_value *params,
129 const bt_component_sink **component);
0d72b8c3 130
4cdfc5e8
PP
131extern bt_graph_status bt_graph_add_sink_component_with_init_method_data(
132 bt_graph *graph, const bt_component_class_sink *component_class,
b19ff26f 133 const char *name, const bt_value *params,
0d72b8c3 134 void *init_method_data,
b19ff26f 135 const bt_component_sink **component);
0d72b8c3 136
4cdfc5e8 137extern bt_graph_status bt_graph_connect_ports(bt_graph *graph,
b19ff26f
PP
138 const bt_port_output *upstream,
139 const bt_port_input *downstream,
140 const bt_connection **connection);
0d72b8c3 141
4cdfc5e8 142extern bt_graph_status bt_graph_run(bt_graph *graph);
0d72b8c3 143
4725a201 144extern bt_graph_status bt_graph_consume(bt_graph *graph);
0d72b8c3 145
4725a201 146extern bt_graph_status bt_graph_add_filter_component_input_port_added_listener(
b19ff26f 147 bt_graph *graph,
0d72b8c3
PP
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
4725a201 152extern bt_graph_status bt_graph_add_sink_component_input_port_added_listener(
b19ff26f 153 bt_graph *graph,
0d72b8c3
PP
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
4725a201 158extern bt_graph_status bt_graph_add_source_component_output_port_added_listener(
b19ff26f 159 bt_graph *graph,
0d72b8c3
PP
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
4725a201 164extern bt_graph_status bt_graph_add_filter_component_output_port_added_listener(
b19ff26f 165 bt_graph *graph,
0d72b8c3
PP
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
4cdfc5e8 170extern bt_graph_status
0d72b8c3 171bt_graph_add_source_filter_component_ports_connected_listener(
b19ff26f 172 bt_graph *graph,
0d72b8c3
PP
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
9c0a126a
PP
177extern bt_graph_status
178bt_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
4cdfc5e8 184extern bt_graph_status
0d72b8c3 185bt_graph_add_source_sink_component_ports_connected_listener(
b19ff26f 186 bt_graph *graph,
0d72b8c3
PP
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
4cdfc5e8 191extern bt_graph_status
0d72b8c3 192bt_graph_add_filter_sink_component_ports_connected_listener(
b19ff26f 193 bt_graph *graph,
0d72b8c3
PP
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
4cdfc5e8 198extern bt_graph_status bt_graph_cancel(bt_graph *graph);
202a3a13 199
c0418dd9
JG
200#ifdef __cplusplus
201}
202#endif
203
1ca80abd 204#endif /* BABELTRACE_GRAPH_GRAPH_H */
This page took 0.052637 seconds and 4 git commands to generate.