lib: make plugin API const-correct
[babeltrace.git] / include / babeltrace / graph / private-graph.h
CommitLineData
a2d06fd5
PP
1#ifndef BABELTRACE_GRAPH_PRIVATE_GRAPH_H
2#define BABELTRACE_GRAPH_PRIVATE_GRAPH_H
3
4/*
5 * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 *
7 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 *
9 * Permission is hereby granted, free of charge, to any person obtaining a copy
10 * of this software and associated documentation files (the "Software"), to deal
11 * in the Software without restriction, including without limitation the rights
12 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 * copies of the Software, and to permit persons to whom the Software is
14 * furnished to do so, subject to the following conditions:
15 *
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
18 *
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25 * SOFTWARE.
26 */
27
28/* For bt_bool */
29#include <babeltrace/types.h>
30
31/* For enum bt_graph_status */
32#include <babeltrace/graph/graph.h>
33
34#ifdef __cplusplus
35extern "C" {
36#endif
37
38struct bt_graph;
39struct bt_private_graph;
d94d92ac
PP
40struct bt_port_input;
41struct bt_port_output;
a2d06fd5
PP
42struct bt_connection;
43struct bt_component;
d94d92ac
PP
44struct bt_component_source;
45struct bt_component_filter;
46struct bt_component_sink;
a2d06fd5
PP
47struct bt_component_class;
48struct bt_value;
49
d94d92ac
PP
50typedef void (*bt_private_graph_filter_component_input_port_added_listener)(
51 struct bt_component_filter *component,
52 struct bt_port_input *port, void *data);
53
54typedef void (*bt_private_graph_sink_component_input_port_added_listener)(
55 struct bt_component_sink *component,
56 struct bt_port_input *port, void *data);
57
58typedef void (*bt_private_graph_source_component_output_port_added_listener)(
59 struct bt_component_source *component,
60 struct bt_port_output *port, void *data);
61
62typedef void (*bt_private_graph_filter_component_output_port_added_listener)(
63 struct bt_component_filter *component,
64 struct bt_port_output *port, void *data);
65
66typedef void (*bt_private_graph_filter_component_input_port_removed_listener)(
67 struct bt_component_filter *component,
68 struct bt_port_input *port, void *data);
69
70typedef void (*bt_private_graph_sink_component_input_port_removed_listener)(
71 struct bt_component_sink *component,
72 struct bt_port_input *port, void *data);
73
74typedef void (*bt_private_graph_source_component_output_port_removed_listener)(
75 struct bt_component_source *component,
76 struct bt_port_output *port, void *data);
77
78typedef void (*bt_private_graph_filter_component_output_port_removed_listener)(
79 struct bt_component_filter *component,
80 struct bt_port_output *port, void *data);
81
82typedef void (*bt_private_graph_source_filter_component_ports_connected_listener)(
83 struct bt_component_source *source_component,
84 struct bt_component_filter *filter_component,
85 struct bt_port_output *upstream_port,
86 struct bt_port_input *downstream_port, void *data);
a2d06fd5 87
d94d92ac
PP
88typedef void (*bt_private_graph_source_sink_component_ports_connected_listener)(
89 struct bt_component_source *source_component,
90 struct bt_component_sink *sink_component,
91 struct bt_port_output *upstream_port,
92 struct bt_port_input *downstream_port, void *data);
a2d06fd5 93
d94d92ac
PP
94typedef void (*bt_private_graph_filter_sink_component_ports_connected_listener)(
95 struct bt_component_filter *filter_component,
96 struct bt_component_sink *sink_component,
97 struct bt_port_output *upstream_port,
98 struct bt_port_input *downstream_port, void *data);
a2d06fd5 99
d94d92ac
PP
100typedef void (*bt_private_graph_source_filter_component_ports_disconnected_listener)(
101 struct bt_component_source *source_component,
102 struct bt_component_filter *filter_component,
103 struct bt_port_output *upstream_port,
104 struct bt_port_input *downstream_port,
105 void *data);
106
107typedef void (*bt_private_graph_source_sink_component_ports_disconnected_listener)(
108 struct bt_component_source *source_component,
109 struct bt_component_sink *sink_component,
110 struct bt_port_output *upstream_port,
111 struct bt_port_input *downstream_port,
112 void *data);
113
114typedef void (*bt_private_graph_filter_sink_component_ports_disconnected_listener)(
115 struct bt_component_filter *filter_component,
116 struct bt_component_sink *sink_component,
117 struct bt_port_output *upstream_port,
118 struct bt_port_input *downstream_port,
a2d06fd5
PP
119 void *data);
120
121typedef void (* bt_private_graph_listener_removed)(void *data);
122
d94d92ac 123static inline
707b7d35 124struct bt_graph *bt_private_graph_as_graph(struct bt_private_graph *graph)
d94d92ac
PP
125{
126 return (void *) graph;
127}
a2d06fd5
PP
128
129extern struct bt_private_graph *bt_private_graph_create(void);
130
d94d92ac 131extern enum bt_graph_status bt_private_graph_add_source_component(
a2d06fd5 132 struct bt_private_graph *graph,
d94d92ac 133 struct bt_component_class_source *component_class,
05e21286 134 const char *name, const struct bt_value *params,
d94d92ac 135 struct bt_component_source **component);
a2d06fd5
PP
136
137extern enum bt_graph_status
d94d92ac 138bt_private_graph_add_source_component_with_init_method_data(
a2d06fd5 139 struct bt_private_graph *graph,
d94d92ac 140 struct bt_component_class_source *component_class,
05e21286 141 const char *name, const struct bt_value *params,
d94d92ac
PP
142 void *init_method_data, struct bt_component_source **component);
143
144extern enum bt_graph_status bt_private_graph_add_filter_component(
145 struct bt_private_graph *graph,
146 struct bt_component_class_filter *component_class,
05e21286 147 const char *name, const struct bt_value *params,
d94d92ac
PP
148 struct bt_component_filter **component);
149
150extern enum bt_graph_status
151bt_private_graph_add_filter_component_with_init_method_data(
152 struct bt_private_graph *graph,
153 struct bt_component_class_filter *component_class,
05e21286 154 const char *name, const struct bt_value *params,
d94d92ac
PP
155 void *init_method_data, struct bt_component_filter **component);
156
157extern enum bt_graph_status bt_private_graph_add_sink_component(
158 struct bt_private_graph *graph,
159 struct bt_component_class_sink *component_class,
05e21286 160 const char *name, const struct bt_value *params,
d94d92ac
PP
161 struct bt_component_sink **component);
162
163extern enum bt_graph_status
164bt_private_graph_add_sink_component_with_init_method_data(
165 struct bt_private_graph *graph,
166 struct bt_component_class_sink *component_class,
05e21286 167 const char *name, const struct bt_value *params,
d94d92ac 168 void *init_method_data, struct bt_component_sink **component);
a2d06fd5 169
a2d06fd5
PP
170extern enum bt_graph_status bt_private_graph_connect_ports(
171 struct bt_private_graph *graph,
d94d92ac
PP
172 struct bt_port_output *upstream,
173 struct bt_port_input *downstream,
a2d06fd5
PP
174 struct bt_connection **connection);
175
a2d06fd5
PP
176extern enum bt_graph_status bt_private_graph_run(
177 struct bt_private_graph *graph);
178
a2d06fd5
PP
179extern enum bt_graph_status bt_private_graph_consume(
180 struct bt_private_graph *graph);
181
d94d92ac
PP
182extern enum bt_graph_status
183bt_private_graph_add_filter_component_input_port_added_listener(
184 struct bt_private_graph *graph,
185 bt_private_graph_filter_component_input_port_added_listener listener,
186 bt_private_graph_listener_removed listener_removed, void *data,
187 int *listener_id);
188
189extern enum bt_graph_status
190bt_private_graph_add_sink_component_input_port_added_listener(
a2d06fd5 191 struct bt_private_graph *graph,
d94d92ac
PP
192 bt_private_graph_sink_component_input_port_added_listener listener,
193 bt_private_graph_listener_removed listener_removed, void *data,
194 int *listener_id);
a2d06fd5 195
d94d92ac
PP
196extern enum bt_graph_status
197bt_private_graph_add_source_component_output_port_added_listener(
a2d06fd5 198 struct bt_private_graph *graph,
d94d92ac
PP
199 bt_private_graph_source_component_output_port_added_listener listener,
200 bt_private_graph_listener_removed listener_removed, void *data,
201 int *listener_id);
a2d06fd5 202
d94d92ac
PP
203extern enum bt_graph_status
204bt_private_graph_add_filter_component_output_port_added_listener(
205 struct bt_private_graph *graph,
206 bt_private_graph_filter_component_output_port_added_listener listener,
207 bt_private_graph_listener_removed listener_removed, void *data,
208 int *listener_id);
209
210extern enum bt_graph_status
211bt_private_graph_add_filter_component_input_port_removed_listener(
212 struct bt_private_graph *graph,
213 bt_private_graph_filter_component_input_port_removed_listener listener,
214 bt_private_graph_listener_removed listener_removed, void *data,
215 int *listener_id);
216
217extern enum bt_graph_status
218bt_private_graph_add_sink_component_input_port_removed_listener(
219 struct bt_private_graph *graph,
220 bt_private_graph_sink_component_input_port_removed_listener listener,
221 bt_private_graph_listener_removed listener_removed, void *data,
222 int *listener_id);
223
224extern enum bt_graph_status
225bt_private_graph_add_source_component_output_port_removed_listener(
226 struct bt_private_graph *graph,
227 bt_private_graph_source_component_output_port_removed_listener listener,
228 bt_private_graph_listener_removed listener_removed, void *data,
229 int *listener_id);
230
231extern enum bt_graph_status
232bt_private_graph_add_filter_component_output_port_removed_listener(
a2d06fd5 233 struct bt_private_graph *graph,
d94d92ac
PP
234 bt_private_graph_filter_component_output_port_removed_listener listener,
235 bt_private_graph_listener_removed listener_removed, void *data,
236 int *listener_id);
a2d06fd5 237
d94d92ac
PP
238extern enum bt_graph_status
239bt_private_graph_add_source_filter_component_ports_connected_listener(
240 struct bt_private_graph *graph,
241 bt_private_graph_source_filter_component_ports_connected_listener listener,
242 bt_private_graph_listener_removed listener_removed, void *data,
243 int *listener_id);
244
245extern enum bt_graph_status
246bt_private_graph_add_source_sink_component_ports_connected_listener(
247 struct bt_private_graph *graph,
248 bt_private_graph_source_sink_component_ports_connected_listener listener,
249 bt_private_graph_listener_removed listener_removed, void *data,
250 int *listener_id);
251
252extern enum bt_graph_status
253bt_private_graph_add_filter_sink_component_ports_connected_listener(
254 struct bt_private_graph *graph,
255 bt_private_graph_filter_sink_component_ports_connected_listener listener,
256 bt_private_graph_listener_removed listener_removed, void *data,
257 int *listener_id);
258
259extern enum bt_graph_status
260bt_private_graph_add_source_filter_component_ports_disconnected_listener(
261 struct bt_private_graph *graph,
262 bt_private_graph_source_filter_component_ports_disconnected_listener listener,
263 bt_private_graph_listener_removed listener_removed, void *data,
264 int *listener_id);
265
266extern enum bt_graph_status
267bt_private_graph_add_source_sink_component_ports_disconnected_listener(
268 struct bt_private_graph *graph,
269 bt_private_graph_source_sink_component_ports_disconnected_listener listener,
270 bt_private_graph_listener_removed listener_removed, void *data,
271 int *listener_id);
272
273extern enum bt_graph_status
274bt_private_graph_add_filter_sink_component_ports_disconnected_listener(
a2d06fd5 275 struct bt_private_graph *graph,
d94d92ac
PP
276 bt_private_graph_filter_sink_component_ports_disconnected_listener listener,
277 bt_private_graph_listener_removed listener_removed, void *data,
278 int *listener_id);
a2d06fd5
PP
279
280extern enum bt_graph_status bt_private_graph_cancel(
281 struct bt_private_graph *graph);
282
283#ifdef __cplusplus
284}
285#endif
286
287#endif /* BABELTRACE_GRAPH_PRIVATE_GRAPH_H */
This page took 0.033908 seconds and 4 git commands to generate.