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 | */ | |
71c5da58 | 34 | #include <babeltrace2/types.h> |
c0418dd9 | 35 | |
ee78f405 | 36 | /* For bt_graph_status */ |
71c5da58 | 37 | #include <babeltrace2/graph/graph-const.h> |
7b53201c | 38 | |
cc81b5ab PP |
39 | /* For bt_logging_level */ |
40 | #include <babeltrace2/logging.h> | |
41 | ||
c0418dd9 JG |
42 | #ifdef __cplusplus |
43 | extern "C" { | |
44 | #endif | |
45 | ||
e18f3e2b SM |
46 | typedef enum bt_graph_listener_status { |
47 | BT_GRAPH_LISTENER_STATUS_OK = 0, | |
48 | BT_GRAPH_LISTENER_STATUS_ERROR = -1, | |
49 | BT_GRAPH_LISTENER_STATUS_NOMEM = -12, | |
50 | } bt_graph_listener_status; | |
51 | ||
52 | typedef bt_graph_listener_status | |
53 | (*bt_graph_filter_component_input_port_added_listener_func)( | |
8eee8ea2 PP |
54 | const bt_component_filter *component, |
55 | const bt_port_input *port, void *data); | |
7b53201c | 56 | |
e18f3e2b SM |
57 | typedef bt_graph_listener_status |
58 | (*bt_graph_sink_component_input_port_added_listener_func)( | |
8eee8ea2 PP |
59 | const bt_component_sink *component, |
60 | const bt_port_input *port, void *data); | |
7b53201c | 61 | |
e18f3e2b SM |
62 | typedef bt_graph_listener_status |
63 | (*bt_graph_source_component_output_port_added_listener_func)( | |
8eee8ea2 PP |
64 | const bt_component_source *component, |
65 | const bt_port_output *port, void *data); | |
7b53201c | 66 | |
e18f3e2b SM |
67 | typedef bt_graph_listener_status |
68 | (*bt_graph_filter_component_output_port_added_listener_func)( | |
8eee8ea2 PP |
69 | const bt_component_filter *component, |
70 | const bt_port_output *port, void *data); | |
7b53201c | 71 | |
e18f3e2b SM |
72 | typedef bt_graph_listener_status |
73 | (*bt_graph_source_filter_component_ports_connected_listener_func)( | |
8eee8ea2 PP |
74 | const bt_component_source *source_component, |
75 | const bt_component_filter *filter_component, | |
76 | const bt_port_output *upstream_port, | |
77 | const bt_port_input *downstream_port, void *data); | |
7b53201c | 78 | |
e18f3e2b SM |
79 | typedef bt_graph_listener_status |
80 | (*bt_graph_source_sink_component_ports_connected_listener_func)( | |
8eee8ea2 PP |
81 | const bt_component_source *source_component, |
82 | const bt_component_sink *sink_component, | |
83 | const bt_port_output *upstream_port, | |
84 | const bt_port_input *downstream_port, void *data); | |
7b53201c | 85 | |
e18f3e2b SM |
86 | typedef bt_graph_listener_status |
87 | (*bt_graph_filter_filter_component_ports_connected_listener_func)( | |
ee976410 PP |
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 | ||
e18f3e2b SM |
94 | typedef bt_graph_listener_status |
95 | (*bt_graph_filter_sink_component_ports_connected_listener_func)( | |
8eee8ea2 PP |
96 | const bt_component_filter *filter_component, |
97 | const bt_component_sink *sink_component, | |
98 | const bt_port_output *upstream_port, | |
99 | const bt_port_input *downstream_port, void *data); | |
7b53201c | 100 | |
7b53201c PP |
101 | typedef void (* bt_graph_listener_removed_func)(void *data); |
102 | ||
8eee8ea2 | 103 | extern bt_graph *bt_graph_create(void); |
7b53201c | 104 | |
ee78f405 | 105 | extern bt_graph_status bt_graph_add_source_component(bt_graph *graph, |
8eee8ea2 PP |
106 | const bt_component_class_source *component_class, |
107 | const char *name, const bt_value *params, | |
cc81b5ab | 108 | bt_logging_level log_level, const bt_component_source **component); |
7b53201c | 109 | |
ee78f405 | 110 | extern bt_graph_status bt_graph_add_source_component_with_init_method_data( |
8eee8ea2 PP |
111 | bt_graph *graph, |
112 | const bt_component_class_source *component_class, | |
113 | const char *name, const bt_value *params, | |
cc81b5ab | 114 | void *init_method_data, bt_logging_level log_level, |
8eee8ea2 | 115 | const bt_component_source **component); |
7b53201c | 116 | |
ee78f405 | 117 | extern bt_graph_status bt_graph_add_filter_component(bt_graph *graph, |
8eee8ea2 PP |
118 | const bt_component_class_filter *component_class, |
119 | const char *name, const bt_value *params, | |
cc81b5ab | 120 | bt_logging_level log_level, |
8eee8ea2 | 121 | const bt_component_filter **component); |
7b53201c | 122 | |
ee78f405 | 123 | extern bt_graph_status bt_graph_add_filter_component_with_init_method_data( |
8eee8ea2 PP |
124 | bt_graph *graph, |
125 | const bt_component_class_filter *component_class, | |
126 | const char *name, const bt_value *params, | |
cc81b5ab | 127 | void *init_method_data, bt_logging_level log_level, |
8eee8ea2 | 128 | const bt_component_filter **component); |
7b53201c | 129 | |
ee78f405 PP |
130 | extern bt_graph_status bt_graph_add_sink_component( |
131 | bt_graph *graph, const bt_component_class_sink *component_class, | |
8eee8ea2 | 132 | const char *name, const bt_value *params, |
cc81b5ab | 133 | bt_logging_level log_level, |
8eee8ea2 | 134 | const bt_component_sink **component); |
7b53201c | 135 | |
ee78f405 PP |
136 | extern bt_graph_status bt_graph_add_sink_component_with_init_method_data( |
137 | bt_graph *graph, const bt_component_class_sink *component_class, | |
8eee8ea2 | 138 | const char *name, const bt_value *params, |
cc81b5ab | 139 | void *init_method_data, bt_logging_level log_level, |
8eee8ea2 | 140 | const bt_component_sink **component); |
7b53201c | 141 | |
ee78f405 | 142 | extern bt_graph_status bt_graph_connect_ports(bt_graph *graph, |
8eee8ea2 PP |
143 | const bt_port_output *upstream, |
144 | const bt_port_input *downstream, | |
145 | const bt_connection **connection); | |
7b53201c | 146 | |
ee78f405 | 147 | extern bt_graph_status bt_graph_run(bt_graph *graph); |
7b53201c | 148 | |
9cce94e4 | 149 | extern bt_graph_status bt_graph_consume(bt_graph *graph); |
7b53201c | 150 | |
9cce94e4 | 151 | extern bt_graph_status bt_graph_add_filter_component_input_port_added_listener( |
8eee8ea2 | 152 | bt_graph *graph, |
7b53201c PP |
153 | bt_graph_filter_component_input_port_added_listener_func listener, |
154 | bt_graph_listener_removed_func listener_removed, void *data, | |
155 | int *listener_id); | |
156 | ||
9cce94e4 | 157 | extern bt_graph_status bt_graph_add_sink_component_input_port_added_listener( |
8eee8ea2 | 158 | bt_graph *graph, |
7b53201c PP |
159 | bt_graph_sink_component_input_port_added_listener_func listener, |
160 | bt_graph_listener_removed_func listener_removed, void *data, | |
161 | int *listener_id); | |
162 | ||
9cce94e4 | 163 | extern bt_graph_status bt_graph_add_source_component_output_port_added_listener( |
8eee8ea2 | 164 | bt_graph *graph, |
7b53201c PP |
165 | bt_graph_source_component_output_port_added_listener_func listener, |
166 | bt_graph_listener_removed_func listener_removed, void *data, | |
167 | int *listener_id); | |
168 | ||
9cce94e4 | 169 | extern bt_graph_status bt_graph_add_filter_component_output_port_added_listener( |
8eee8ea2 | 170 | bt_graph *graph, |
7b53201c PP |
171 | bt_graph_filter_component_output_port_added_listener_func listener, |
172 | bt_graph_listener_removed_func listener_removed, void *data, | |
173 | int *listener_id); | |
174 | ||
ee78f405 | 175 | extern bt_graph_status |
7b53201c | 176 | bt_graph_add_source_filter_component_ports_connected_listener( |
8eee8ea2 | 177 | bt_graph *graph, |
7b53201c PP |
178 | bt_graph_source_filter_component_ports_connected_listener_func listener, |
179 | bt_graph_listener_removed_func listener_removed, void *data, | |
180 | int *listener_id); | |
181 | ||
ee976410 PP |
182 | extern bt_graph_status |
183 | bt_graph_add_filter_filter_component_ports_connected_listener( | |
184 | bt_graph *graph, | |
185 | bt_graph_filter_filter_component_ports_connected_listener_func listener, | |
186 | bt_graph_listener_removed_func listener_removed, void *data, | |
187 | int *listener_id); | |
188 | ||
ee78f405 | 189 | extern bt_graph_status |
7b53201c | 190 | bt_graph_add_source_sink_component_ports_connected_listener( |
8eee8ea2 | 191 | bt_graph *graph, |
7b53201c PP |
192 | bt_graph_source_sink_component_ports_connected_listener_func listener, |
193 | bt_graph_listener_removed_func listener_removed, void *data, | |
194 | int *listener_id); | |
195 | ||
ee78f405 | 196 | extern bt_graph_status |
7b53201c | 197 | bt_graph_add_filter_sink_component_ports_connected_listener( |
8eee8ea2 | 198 | bt_graph *graph, |
7b53201c PP |
199 | bt_graph_filter_sink_component_ports_connected_listener_func listener, |
200 | bt_graph_listener_removed_func listener_removed, void *data, | |
201 | int *listener_id); | |
202 | ||
ee78f405 | 203 | extern bt_graph_status bt_graph_cancel(bt_graph *graph); |
202a3a13 | 204 | |
c0418dd9 JG |
205 | #ifdef __cplusplus |
206 | } | |
207 | #endif | |
208 | ||
1ca80abd | 209 | #endif /* BABELTRACE_GRAPH_GRAPH_H */ |