Commit | Line | Data |
---|---|---|
1ca80abd PP |
1 | #ifndef BABELTRACE_GRAPH_GRAPH_H |
2 | #define BABELTRACE_GRAPH_GRAPH_H | |
c0418dd9 JG |
3 | |
4 | /* | |
f60c8b34 | 5 | * BabelTrace - Babeltrace Graph Interface |
c0418dd9 | 6 | * |
f60c8b34 | 7 | * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
c0418dd9 JG |
8 | * |
9 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
10 | * | |
11 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
12 | * of this software and associated documentation files (the "Software"), to deal | |
13 | * in the Software without restriction, including without limitation the rights | |
14 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
15 | * copies of the Software, and to permit persons to whom the Software is | |
16 | * furnished to do so, subject to the following conditions: | |
17 | * | |
18 | * The above copyright notice and this permission notice shall be included in | |
19 | * all copies or substantial portions of the Software. | |
20 | * | |
21 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
22 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
23 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
24 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
25 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
26 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
27 | * SOFTWARE. | |
28 | */ | |
29 | ||
b2e0c907 | 30 | #include <babeltrace/graph/component.h> |
202a3a13 | 31 | #include <babeltrace/types.h> |
c0418dd9 JG |
32 | |
33 | #ifdef __cplusplus | |
34 | extern "C" { | |
35 | #endif | |
36 | ||
f60c8b34 JG |
37 | struct bt_port; |
38 | struct bt_connection; | |
c0418dd9 | 39 | |
f60c8b34 | 40 | enum bt_graph_status { |
a256a42d | 41 | BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION = 111, |
4a6b963e PP |
42 | /** Canceled. */ |
43 | BT_GRAPH_STATUS_CANCELED = 125, | |
72b913fb | 44 | /** No sink can consume at the moment. */ |
fe8ad2b6 | 45 | BT_GRAPH_STATUS_AGAIN = 11, |
f60c8b34 JG |
46 | /** Downstream component does not support multiple inputs. */ |
47 | BT_GRAPH_STATUS_END = 1, | |
48 | BT_GRAPH_STATUS_OK = 0, | |
f60c8b34 JG |
49 | /** Component is already part of another graph. */ |
50 | BT_GRAPH_STATUS_ALREADY_IN_A_GRAPH = -2, | |
51 | /** Invalid arguments. */ | |
fe8ad2b6 | 52 | BT_GRAPH_STATUS_INVALID = -22, |
f60c8b34 | 53 | /** No sink in graph. */ |
fe8ad2b6 | 54 | BT_GRAPH_STATUS_NO_SINK = -6, |
f60c8b34 | 55 | /** General error. */ |
fe8ad2b6 | 56 | BT_GRAPH_STATUS_ERROR = -1, |
a256a42d | 57 | BT_GRAPH_STATUS_NOMEM = -12, |
f60c8b34 | 58 | }; |
c0418dd9 | 59 | |
1bf957a0 PP |
60 | typedef void (*bt_graph_port_added_listener)(struct bt_port *port, |
61 | void *data); | |
62 | typedef void (*bt_graph_port_removed_listener)(struct bt_component *component, | |
63 | struct bt_port *port, void *data); | |
f345f8bb PP |
64 | typedef void (*bt_graph_ports_connected_listener)(struct bt_port *upstream_port, |
65 | struct bt_port *downstream_port, void *data); | |
66 | typedef void (*bt_graph_ports_disconnected_listener)( | |
67 | struct bt_component *upstream_component, | |
68 | struct bt_component *downstream_component, | |
69 | struct bt_port *upstream_port, struct bt_port *downstream_port, | |
1bf957a0 PP |
70 | void *data); |
71 | ||
f60c8b34 | 72 | extern struct bt_graph *bt_graph_create(void); |
c0418dd9 JG |
73 | |
74 | /** | |
f60c8b34 JG |
75 | * Creates a connection between two components using the two ports specified |
76 | * and adds the connection and components (if not already added) to the graph. | |
c0418dd9 | 77 | */ |
a256a42d PP |
78 | extern enum bt_graph_status bt_graph_connect_ports(struct bt_graph *graph, |
79 | struct bt_port *upstream, struct bt_port *downstream, | |
80 | struct bt_connection **connection); | |
c0418dd9 | 81 | |
c0418dd9 | 82 | /** |
f60c8b34 JG |
83 | * Run graph to completion or until a single sink is left and "AGAIN" is received. |
84 | * | |
c0418dd9 | 85 | * Runs "bt_component_sink_consume()" on all sinks in round-robin until they all |
f60c8b34 JG |
86 | * indicate that the end is reached or that an error occured. |
87 | */ | |
72b913fb | 88 | extern enum bt_graph_status bt_graph_run(struct bt_graph *graph); |
f60c8b34 JG |
89 | |
90 | /** | |
91 | * Runs "bt_component_sink_consume()" on the graph's sinks. Each invokation will | |
92 | * invoke "bt_component_sink_consume()" on the next sink, in round-robin, until | |
93 | * they all indicated that the end is reached. | |
c0418dd9 | 94 | */ |
72b913fb | 95 | extern enum bt_graph_status bt_graph_consume(struct bt_graph *graph); |
c0418dd9 | 96 | |
0d107cdd | 97 | extern int bt_graph_add_port_added_listener(struct bt_graph *graph, |
1bf957a0 PP |
98 | bt_graph_port_added_listener listener, void *data); |
99 | ||
0d107cdd | 100 | extern int bt_graph_add_port_removed_listener(struct bt_graph *graph, |
1bf957a0 PP |
101 | bt_graph_port_removed_listener listener, void *data); |
102 | ||
0d107cdd | 103 | extern int bt_graph_add_ports_connected_listener(struct bt_graph *graph, |
f345f8bb | 104 | bt_graph_ports_connected_listener listener, void *data); |
1bf957a0 | 105 | |
0d107cdd | 106 | extern int bt_graph_add_ports_disconnected_listener(struct bt_graph *graph, |
f345f8bb | 107 | bt_graph_ports_disconnected_listener listener, void *data); |
1bf957a0 | 108 | |
202a3a13 PP |
109 | extern enum bt_graph_status bt_graph_cancel(struct bt_graph *graph); |
110 | extern bt_bool bt_graph_is_canceled(struct bt_graph *graph); | |
111 | ||
c0418dd9 JG |
112 | #ifdef __cplusplus |
113 | } | |
114 | #endif | |
115 | ||
1ca80abd | 116 | #endif /* BABELTRACE_GRAPH_GRAPH_H */ |