Commit | Line | Data |
---|---|---|
1ca80abd PP |
1 | #ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_H |
2 | #define BABELTRACE_GRAPH_COMPONENT_CLASS_H | |
fc11e32c JG |
3 | |
4 | /* | |
5 | * Babeltrace - Component Class Interface. | |
6 | * | |
7 | * Copyright 2016 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 | ||
cd95962c | 28 | #include <stdint.h> |
9d408fca PP |
29 | |
30 | /* For enum bt_component_status */ | |
cc469c42 | 31 | #include <babeltrace/graph/component-status.h> |
9d408fca PP |
32 | |
33 | /* For enum bt_notification_iterator_status */ | |
cc469c42 | 34 | #include <babeltrace/graph/notification-iterator.h> |
9d408fca PP |
35 | |
36 | /* For enum bt_query_status */ | |
c7eee084 | 37 | #include <babeltrace/graph/query-executor.h> |
9d408fca PP |
38 | |
39 | /* For bt_bool */ | |
c55a9f58 | 40 | #include <babeltrace/types.h> |
33b34c43 | 41 | |
fc11e32c JG |
42 | #ifdef __cplusplus |
43 | extern "C" { | |
44 | #endif | |
45 | ||
fc11e32c | 46 | struct bt_component_class; |
cd95962c | 47 | struct bt_component; |
890882ef PP |
48 | struct bt_private_component; |
49 | struct bt_private_port; | |
8f4799f7 | 50 | struct bt_port; |
cd95962c | 51 | struct bt_value; |
90157d89 | 52 | struct bt_private_connection_private_notification_iterator; |
c7eee084 | 53 | struct bt_query_executor; |
fc11e32c | 54 | |
d3e4dcd8 PP |
55 | /** |
56 | * Component class type. | |
57 | */ | |
58 | enum bt_component_class_type { | |
59 | BT_COMPONENT_CLASS_TYPE_UNKNOWN = -1, | |
60 | ||
61 | /** A source component is a notification generator. */ | |
62 | BT_COMPONENT_CLASS_TYPE_SOURCE = 0, | |
63 | ||
64 | /** A sink component handles incoming notifications. */ | |
65 | BT_COMPONENT_CLASS_TYPE_SINK = 1, | |
66 | ||
67 | /** A filter component implements both Source and Sink interfaces. */ | |
68 | BT_COMPONENT_CLASS_TYPE_FILTER = 2, | |
69 | }; | |
70 | ||
90157d89 | 71 | struct bt_notification_iterator_next_method_return { |
a22f4171 PP |
72 | struct bt_notification *notification; |
73 | enum bt_notification_iterator_status status; | |
74 | }; | |
75 | ||
90157d89 | 76 | struct bt_component_class_query_method_return { |
c7eee084 PP |
77 | struct bt_value *result; |
78 | enum bt_query_status status; | |
79 | }; | |
80 | ||
d3e4dcd8 | 81 | typedef enum bt_component_status (*bt_component_class_init_method)( |
890882ef PP |
82 | struct bt_private_component *private_component, |
83 | struct bt_value *params, void *init_method_data); | |
d3e4dcd8 | 84 | |
64cadc66 | 85 | typedef void (*bt_component_class_finalize_method)( |
890882ef | 86 | struct bt_private_component *private_component); |
d3e4dcd8 | 87 | |
d3eb6e8f PP |
88 | typedef enum bt_notification_iterator_status |
89 | (*bt_component_class_notification_iterator_init_method)( | |
90157d89 | 90 | struct bt_private_connection_private_notification_iterator *notification_iterator, |
91457551 | 91 | struct bt_private_port *private_port); |
d3eb6e8f | 92 | |
64cadc66 | 93 | typedef void (*bt_component_class_notification_iterator_finalize_method)( |
90157d89 | 94 | struct bt_private_connection_private_notification_iterator *notification_iterator); |
d3eb6e8f | 95 | |
90157d89 PP |
96 | typedef struct bt_notification_iterator_next_method_return |
97 | (*bt_component_class_notification_iterator_next_method)( | |
98 | struct bt_private_connection_private_notification_iterator *notification_iterator); | |
d3eb6e8f | 99 | |
90157d89 | 100 | typedef struct bt_component_class_query_method_return (*bt_component_class_query_method)( |
efa96d5d | 101 | struct bt_component_class *component_class, |
c7eee084 | 102 | struct bt_query_executor *query_executor, |
a67681c1 | 103 | const char *object, struct bt_value *params); |
efa96d5d | 104 | |
72b913fb | 105 | typedef enum bt_component_status (*bt_component_class_accept_port_connection_method)( |
890882ef | 106 | struct bt_private_component *private_component, |
8f4799f7 PP |
107 | struct bt_private_port *self_private_port, |
108 | struct bt_port *other_port); | |
72b913fb | 109 | |
0d8b4d8e PP |
110 | typedef void (*bt_component_class_port_connected_method)( |
111 | struct bt_private_component *private_component, | |
112 | struct bt_private_port *self_private_port, | |
113 | struct bt_port *other_port); | |
114 | ||
72b913fb | 115 | typedef void (*bt_component_class_port_disconnected_method)( |
890882ef PP |
116 | struct bt_private_component *private_component, |
117 | struct bt_private_port *private_port); | |
2d41b99e | 118 | |
d3e4dcd8 PP |
119 | extern int bt_component_class_set_init_method( |
120 | struct bt_component_class *component_class, | |
90157d89 | 121 | bt_component_class_init_method method); |
d3e4dcd8 | 122 | |
64cadc66 | 123 | extern int bt_component_class_set_finalize_method( |
d3e4dcd8 | 124 | struct bt_component_class *component_class, |
90157d89 | 125 | bt_component_class_finalize_method method); |
d3e4dcd8 | 126 | |
72b913fb PP |
127 | extern int bt_component_class_set_accept_port_connection_method( |
128 | struct bt_component_class *component_class, | |
90157d89 | 129 | bt_component_class_accept_port_connection_method method); |
72b913fb | 130 | |
0d8b4d8e PP |
131 | extern int bt_component_class_set_port_connected_method( |
132 | struct bt_component_class *component_class, | |
90157d89 | 133 | bt_component_class_port_connected_method method); |
0d8b4d8e | 134 | |
72b913fb | 135 | extern int bt_component_class_set_port_disconnected_method( |
2d41b99e | 136 | struct bt_component_class *component_class, |
90157d89 | 137 | bt_component_class_port_disconnected_method method); |
72b913fb PP |
138 | |
139 | extern int bt_component_class_set_query_method( | |
140 | struct bt_component_class *component_class, | |
90157d89 | 141 | bt_component_class_query_method method); |
2d41b99e | 142 | |
d3e4dcd8 PP |
143 | extern int bt_component_class_set_description( |
144 | struct bt_component_class *component_class, | |
145 | const char *description); | |
38b48196 | 146 | |
5536d9a6 PP |
147 | extern int bt_component_class_set_help( |
148 | struct bt_component_class *component_class, | |
149 | const char *help); | |
150 | ||
1e4d8103 PP |
151 | extern int bt_component_class_freeze( |
152 | struct bt_component_class *component_class); | |
153 | ||
38b48196 JG |
154 | /** |
155 | * Get a component class' name. | |
156 | * | |
157 | * @param component_class Component class of which to get the name | |
158 | * @returns Name of the component class | |
159 | */ | |
160 | extern const char *bt_component_class_get_name( | |
161 | struct bt_component_class *component_class); | |
162 | ||
7c7c0433 JG |
163 | /** |
164 | * Get a component class' description. | |
165 | * | |
166 | * Component classes may provide an optional description. It may, however, | |
167 | * opt not to. | |
168 | * | |
169 | * @param component_class Component class of which to get the description | |
170 | * @returns Description of the component class, or NULL. | |
171 | */ | |
f3bc2010 | 172 | extern const char *bt_component_class_get_description( |
7c7c0433 JG |
173 | struct bt_component_class *component_class); |
174 | ||
5536d9a6 PP |
175 | extern const char *bt_component_class_get_help( |
176 | struct bt_component_class *component_class); | |
177 | ||
38b48196 JG |
178 | /** |
179 | * Get a component class' type. | |
180 | * | |
181 | * @param component_class Component class of which to get the type | |
182 | * @returns One of #bt_component_type | |
183 | */ | |
d3e4dcd8 | 184 | extern enum bt_component_class_type bt_component_class_get_type( |
fc11e32c JG |
185 | struct bt_component_class *component_class); |
186 | ||
2154eb7d | 187 | static inline |
c55a9f58 | 188 | bt_bool bt_component_class_is_source(struct bt_component_class *component_class) |
2154eb7d PP |
189 | { |
190 | return bt_component_class_get_type(component_class) == | |
191 | BT_COMPONENT_CLASS_TYPE_SOURCE; | |
192 | } | |
193 | ||
194 | static inline | |
c55a9f58 | 195 | bt_bool bt_component_class_is_filter(struct bt_component_class *component_class) |
2154eb7d PP |
196 | { |
197 | return bt_component_class_get_type(component_class) == | |
198 | BT_COMPONENT_CLASS_TYPE_FILTER; | |
199 | } | |
200 | ||
201 | static inline | |
c55a9f58 | 202 | bt_bool bt_component_class_is_sink(struct bt_component_class *component_class) |
2154eb7d PP |
203 | { |
204 | return bt_component_class_get_type(component_class) == | |
205 | BT_COMPONENT_CLASS_TYPE_SINK; | |
206 | } | |
207 | ||
d3e4dcd8 PP |
208 | #ifdef __cplusplus |
209 | } | |
210 | #endif | |
211 | ||
1ca80abd | 212 | #endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_H */ |