Commit | Line | Data |
---|---|---|
1ca80abd PP |
1 | #ifndef BABELTRACE_GRAPH_GRAPH_H |
2 | #define BABELTRACE_GRAPH_GRAPH_H | |
c0418dd9 JG |
3 | |
4 | /* | |
f2b0325d | 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 | ||
8eee8ea2 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 | |
ee78f405 | 36 | /* For bt_graph_status */ |
7b53201c PP |
37 | #include <babeltrace/graph/graph-const.h> |
38 | ||
c0418dd9 JG |
39 | #ifdef __cplusplus |
40 | extern "C" { | |
41 | #endif | |
42 | ||
7b53201c | 43 | typedef void (*bt_graph_filter_component_input_port_added_listener_func)( |
8eee8ea2 PP |
44 | const bt_component_filter *component, |
45 | const bt_port_input *port, void *data); | |
7b53201c PP |
46 | |
47 | typedef void (*bt_graph_sink_component_input_port_added_listener_func)( | |
8eee8ea2 PP |
48 | const bt_component_sink *component, |
49 | const bt_port_input *port, void *data); | |
7b53201c PP |
50 | |
51 | typedef void (*bt_graph_source_component_output_port_added_listener_func)( | |
8eee8ea2 PP |
52 | const bt_component_source *component, |
53 | const bt_port_output *port, void *data); | |
7b53201c PP |
54 | |
55 | typedef void (*bt_graph_filter_component_output_port_added_listener_func)( | |
8eee8ea2 PP |
56 | const bt_component_filter *component, |
57 | const bt_port_output *port, void *data); | |
7b53201c PP |
58 | |
59 | typedef void (*bt_graph_filter_component_input_port_removed_listener_func)( | |
8eee8ea2 PP |
60 | const bt_component_filter *component, |
61 | const bt_port_input *port, void *data); | |
7b53201c PP |
62 | |
63 | typedef void (*bt_graph_sink_component_input_port_removed_listener_func)( | |
8eee8ea2 PP |
64 | const bt_component_sink *component, |
65 | const bt_port_input *port, void *data); | |
7b53201c PP |
66 | |
67 | typedef void (*bt_graph_source_component_output_port_removed_listener_func)( | |
8eee8ea2 PP |
68 | const bt_component_source *component, |
69 | const bt_port_output *port, void *data); | |
7b53201c PP |
70 | |
71 | typedef void (*bt_graph_filter_component_output_port_removed_listener_func)( | |
8eee8ea2 PP |
72 | const bt_component_filter *component, |
73 | const bt_port_output *port, void *data); | |
7b53201c PP |
74 | |
75 | typedef void (*bt_graph_source_filter_component_ports_connected_listener_func)( | |
8eee8ea2 PP |
76 | const bt_component_source *source_component, |
77 | const bt_component_filter *filter_component, | |
78 | const bt_port_output *upstream_port, | |
79 | const bt_port_input *downstream_port, void *data); | |
7b53201c PP |
80 | |
81 | typedef void (*bt_graph_source_sink_component_ports_connected_listener_func)( | |
8eee8ea2 PP |
82 | const bt_component_source *source_component, |
83 | const bt_component_sink *sink_component, | |
84 | const bt_port_output *upstream_port, | |
85 | const bt_port_input *downstream_port, void *data); | |
7b53201c | 86 | |
ee976410 PP |
87 | typedef void (*bt_graph_filter_filter_component_ports_connected_listener_func)( |
88 | const bt_component_filter *filter_component_upstream, | |
89 | const bt_component_filter *filter_component_downstream, | |
90 | const bt_port_output *upstream_port, | |
91 | const bt_port_input *downstream_port, | |
92 | void *data); | |
93 | ||
7b53201c | 94 | typedef void (*bt_graph_filter_sink_component_ports_connected_listener_func)( |
8eee8ea2 PP |
95 | const bt_component_filter *filter_component, |
96 | const bt_component_sink *sink_component, | |
97 | const bt_port_output *upstream_port, | |
98 | const bt_port_input *downstream_port, void *data); | |
7b53201c PP |
99 | |
100 | typedef void (*bt_graph_source_filter_component_ports_disconnected_listener_func)( | |
8eee8ea2 PP |
101 | const bt_component_source *source_component, |
102 | const bt_component_filter *filter_component, | |
103 | const bt_port_output *upstream_port, | |
104 | const bt_port_input *downstream_port, | |
7b53201c PP |
105 | void *data); |
106 | ||
107 | typedef void (*bt_graph_source_sink_component_ports_disconnected_listener_func)( | |
8eee8ea2 PP |
108 | const bt_component_source *source_component, |
109 | const bt_component_sink *sink_component, | |
110 | const bt_port_output *upstream_port, | |
111 | const bt_port_input *downstream_port, | |
7b53201c PP |
112 | void *data); |
113 | ||
ee976410 PP |
114 | typedef void (*bt_graph_filter_filter_component_ports_disconnected_listener_func)( |
115 | const bt_component_filter *filter_component_upstream, | |
116 | const bt_component_filter *filter_component_downstream, | |
117 | const bt_port_output *upstream_port, | |
118 | const bt_port_input *downstream_port, | |
119 | void *data); | |
120 | ||
7b53201c | 121 | typedef void (*bt_graph_filter_sink_component_ports_disconnected_listener_func)( |
8eee8ea2 PP |
122 | const bt_component_filter *filter_component, |
123 | const bt_component_sink *sink_component, | |
124 | const bt_port_output *upstream_port, | |
125 | const bt_port_input *downstream_port, | |
7b53201c PP |
126 | void *data); |
127 | ||
128 | typedef void (* bt_graph_listener_removed_func)(void *data); | |
129 | ||
8eee8ea2 | 130 | extern bt_graph *bt_graph_create(void); |
7b53201c | 131 | |
ee78f405 | 132 | extern bt_graph_status bt_graph_add_source_component(bt_graph *graph, |
8eee8ea2 PP |
133 | const bt_component_class_source *component_class, |
134 | const char *name, const bt_value *params, | |
135 | const bt_component_source **component); | |
7b53201c | 136 | |
ee78f405 | 137 | extern bt_graph_status bt_graph_add_source_component_with_init_method_data( |
8eee8ea2 PP |
138 | bt_graph *graph, |
139 | const bt_component_class_source *component_class, | |
140 | const char *name, const bt_value *params, | |
7b53201c | 141 | void *init_method_data, |
8eee8ea2 | 142 | const bt_component_source **component); |
7b53201c | 143 | |
ee78f405 | 144 | extern bt_graph_status bt_graph_add_filter_component(bt_graph *graph, |
8eee8ea2 PP |
145 | const bt_component_class_filter *component_class, |
146 | const char *name, const bt_value *params, | |
147 | const bt_component_filter **component); | |
7b53201c | 148 | |
ee78f405 | 149 | extern bt_graph_status bt_graph_add_filter_component_with_init_method_data( |
8eee8ea2 PP |
150 | bt_graph *graph, |
151 | const bt_component_class_filter *component_class, | |
152 | const char *name, const bt_value *params, | |
7b53201c | 153 | void *init_method_data, |
8eee8ea2 | 154 | const bt_component_filter **component); |
7b53201c | 155 | |
ee78f405 PP |
156 | extern bt_graph_status bt_graph_add_sink_component( |
157 | bt_graph *graph, const bt_component_class_sink *component_class, | |
8eee8ea2 PP |
158 | const char *name, const bt_value *params, |
159 | const bt_component_sink **component); | |
7b53201c | 160 | |
ee78f405 PP |
161 | extern bt_graph_status bt_graph_add_sink_component_with_init_method_data( |
162 | bt_graph *graph, const bt_component_class_sink *component_class, | |
8eee8ea2 | 163 | const char *name, const bt_value *params, |
7b53201c | 164 | void *init_method_data, |
8eee8ea2 | 165 | const bt_component_sink **component); |
7b53201c | 166 | |
ee78f405 | 167 | extern bt_graph_status bt_graph_connect_ports(bt_graph *graph, |
8eee8ea2 PP |
168 | const bt_port_output *upstream, |
169 | const bt_port_input *downstream, | |
170 | const bt_connection **connection); | |
7b53201c | 171 | |
ee78f405 | 172 | extern bt_graph_status bt_graph_run(bt_graph *graph); |
7b53201c | 173 | |
ee78f405 | 174 | extern bt_graph_status bt_graph_consume( |
8eee8ea2 | 175 | bt_graph *graph); |
7b53201c | 176 | |
ee78f405 | 177 | extern bt_graph_status |
7b53201c | 178 | bt_graph_add_filter_component_input_port_added_listener( |
8eee8ea2 | 179 | bt_graph *graph, |
7b53201c PP |
180 | bt_graph_filter_component_input_port_added_listener_func listener, |
181 | bt_graph_listener_removed_func listener_removed, void *data, | |
182 | int *listener_id); | |
183 | ||
ee78f405 | 184 | extern bt_graph_status |
7b53201c | 185 | bt_graph_add_sink_component_input_port_added_listener( |
8eee8ea2 | 186 | bt_graph *graph, |
7b53201c PP |
187 | bt_graph_sink_component_input_port_added_listener_func listener, |
188 | bt_graph_listener_removed_func listener_removed, void *data, | |
189 | int *listener_id); | |
190 | ||
ee78f405 | 191 | extern bt_graph_status |
7b53201c | 192 | bt_graph_add_source_component_output_port_added_listener( |
8eee8ea2 | 193 | bt_graph *graph, |
7b53201c PP |
194 | bt_graph_source_component_output_port_added_listener_func listener, |
195 | bt_graph_listener_removed_func listener_removed, void *data, | |
196 | int *listener_id); | |
197 | ||
ee78f405 | 198 | extern bt_graph_status |
7b53201c | 199 | bt_graph_add_filter_component_output_port_added_listener( |
8eee8ea2 | 200 | bt_graph *graph, |
7b53201c PP |
201 | bt_graph_filter_component_output_port_added_listener_func listener, |
202 | bt_graph_listener_removed_func listener_removed, void *data, | |
203 | int *listener_id); | |
204 | ||
ee78f405 | 205 | extern bt_graph_status |
7b53201c | 206 | bt_graph_add_filter_component_input_port_removed_listener( |
8eee8ea2 | 207 | bt_graph *graph, |
7b53201c PP |
208 | bt_graph_filter_component_input_port_removed_listener_func listener, |
209 | bt_graph_listener_removed_func listener_removed, void *data, | |
210 | int *listener_id); | |
211 | ||
ee78f405 | 212 | extern bt_graph_status |
7b53201c | 213 | bt_graph_add_sink_component_input_port_removed_listener( |
8eee8ea2 | 214 | bt_graph *graph, |
7b53201c PP |
215 | bt_graph_sink_component_input_port_removed_listener_func listener, |
216 | bt_graph_listener_removed_func listener_removed, void *data, | |
217 | int *listener_id); | |
218 | ||
ee78f405 | 219 | extern bt_graph_status |
7b53201c | 220 | bt_graph_add_source_component_output_port_removed_listener( |
8eee8ea2 | 221 | bt_graph *graph, |
7b53201c PP |
222 | bt_graph_source_component_output_port_removed_listener_func listener, |
223 | bt_graph_listener_removed_func listener_removed, void *data, | |
224 | int *listener_id); | |
225 | ||
ee78f405 | 226 | extern bt_graph_status |
7b53201c | 227 | bt_graph_add_filter_component_output_port_removed_listener( |
8eee8ea2 | 228 | bt_graph *graph, |
7b53201c PP |
229 | bt_graph_filter_component_output_port_removed_listener_func listener, |
230 | bt_graph_listener_removed_func listener_removed, void *data, | |
231 | int *listener_id); | |
232 | ||
ee78f405 | 233 | extern bt_graph_status |
7b53201c | 234 | bt_graph_add_source_filter_component_ports_connected_listener( |
8eee8ea2 | 235 | bt_graph *graph, |
7b53201c PP |
236 | bt_graph_source_filter_component_ports_connected_listener_func listener, |
237 | bt_graph_listener_removed_func listener_removed, void *data, | |
238 | int *listener_id); | |
239 | ||
ee976410 PP |
240 | extern bt_graph_status |
241 | bt_graph_add_filter_filter_component_ports_connected_listener( | |
242 | bt_graph *graph, | |
243 | bt_graph_filter_filter_component_ports_connected_listener_func listener, | |
244 | bt_graph_listener_removed_func listener_removed, void *data, | |
245 | int *listener_id); | |
246 | ||
ee78f405 | 247 | extern bt_graph_status |
7b53201c | 248 | bt_graph_add_source_sink_component_ports_connected_listener( |
8eee8ea2 | 249 | bt_graph *graph, |
7b53201c PP |
250 | bt_graph_source_sink_component_ports_connected_listener_func listener, |
251 | bt_graph_listener_removed_func listener_removed, void *data, | |
252 | int *listener_id); | |
253 | ||
ee78f405 | 254 | extern bt_graph_status |
7b53201c | 255 | bt_graph_add_filter_sink_component_ports_connected_listener( |
8eee8ea2 | 256 | bt_graph *graph, |
7b53201c PP |
257 | bt_graph_filter_sink_component_ports_connected_listener_func listener, |
258 | bt_graph_listener_removed_func listener_removed, void *data, | |
259 | int *listener_id); | |
260 | ||
ee78f405 | 261 | extern bt_graph_status |
7b53201c | 262 | bt_graph_add_source_filter_component_ports_disconnected_listener( |
8eee8ea2 | 263 | bt_graph *graph, |
7b53201c PP |
264 | bt_graph_source_filter_component_ports_disconnected_listener_func listener, |
265 | bt_graph_listener_removed_func listener_removed, void *data, | |
266 | int *listener_id); | |
267 | ||
ee976410 PP |
268 | extern bt_graph_status |
269 | bt_graph_add_filter_filter_component_ports_disconnected_listener( | |
270 | bt_graph *graph, | |
271 | bt_graph_filter_filter_component_ports_disconnected_listener_func listener, | |
272 | bt_graph_listener_removed_func listener_removed, void *data, | |
273 | int *listener_id); | |
274 | ||
ee78f405 | 275 | extern bt_graph_status |
7b53201c | 276 | bt_graph_add_source_sink_component_ports_disconnected_listener( |
8eee8ea2 | 277 | bt_graph *graph, |
7b53201c PP |
278 | bt_graph_source_sink_component_ports_disconnected_listener_func listener, |
279 | bt_graph_listener_removed_func listener_removed, void *data, | |
280 | int *listener_id); | |
281 | ||
ee78f405 | 282 | extern bt_graph_status |
7b53201c | 283 | bt_graph_add_filter_sink_component_ports_disconnected_listener( |
8eee8ea2 | 284 | bt_graph *graph, |
7b53201c PP |
285 | bt_graph_filter_sink_component_ports_disconnected_listener_func listener, |
286 | bt_graph_listener_removed_func listener_removed, void *data, | |
287 | int *listener_id); | |
c0418dd9 | 288 | |
ee78f405 | 289 | extern bt_graph_status bt_graph_cancel(bt_graph *graph); |
202a3a13 | 290 | |
c0418dd9 JG |
291 | #ifdef __cplusplus |
292 | } | |
293 | #endif | |
294 | ||
1ca80abd | 295 | #endif /* BABELTRACE_GRAPH_GRAPH_H */ |