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