Commit | Line | Data |
---|---|---|
1ca80abd PP |
1 | #ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_FILTER_H |
2 | #define BABELTRACE_GRAPH_COMPONENT_CLASS_FILTER_H | |
d3e4dcd8 PP |
3 | |
4 | /* | |
f2b0325d | 5 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
d3e4dcd8 PP |
6 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
7 | * | |
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 | ||
7b53201c PP |
27 | #include <stdint.h> |
28 | ||
ee78f405 | 29 | /* For bt_self_component_status */ |
71c5da58 | 30 | #include <babeltrace2/graph/self-component.h> |
7b53201c | 31 | |
ee78f405 | 32 | /* For bt_self_message_iterator_status */ |
71c5da58 | 33 | #include <babeltrace2/graph/self-message-iterator.h> |
7b53201c | 34 | |
ee78f405 | 35 | /* For bt_query_status */ |
71c5da58 | 36 | #include <babeltrace2/graph/component-class.h> |
7b53201c | 37 | |
4d2e0cb5 | 38 | /* For bt_component_class_status */ |
71c5da58 | 39 | #include <babeltrace2/graph/component-class-const.h> |
4d2e0cb5 | 40 | |
8eee8ea2 PP |
41 | /* |
42 | * For bt_component_class, bt_component_class_filter, bt_port_input, | |
43 | * bt_port_output, bt_query_executor, bt_self_component_class_filter, | |
44 | * bt_self_component_filter, bt_self_component_port_input, | |
15a52f66 | 45 | * bt_self_component_port_output, bt_value, bt_message_array_const, |
8470daa9 | 46 | * bt_bool, bt_self_message_iterator, __BT_UPCAST |
8eee8ea2 | 47 | */ |
71c5da58 | 48 | #include <babeltrace2/types.h> |
8eee8ea2 | 49 | |
d3e4dcd8 PP |
50 | #ifdef __cplusplus |
51 | extern "C" { | |
52 | #endif | |
53 | ||
ee78f405 | 54 | typedef bt_self_component_status |
7b53201c | 55 | (*bt_component_class_filter_init_method)( |
8eee8ea2 PP |
56 | bt_self_component_filter *self_component, |
57 | const bt_value *params, void *init_method_data); | |
7b53201c PP |
58 | |
59 | typedef void (*bt_component_class_filter_finalize_method)( | |
8eee8ea2 | 60 | bt_self_component_filter *self_component); |
7b53201c | 61 | |
ee78f405 | 62 | typedef bt_self_message_iterator_status |
b09a5592 PP |
63 | (*bt_component_class_filter_message_iterator_init_method)( |
64 | bt_self_message_iterator *message_iterator, | |
8eee8ea2 PP |
65 | bt_self_component_filter *self_component, |
66 | bt_self_component_port_output *port); | |
7b53201c PP |
67 | |
68 | typedef void | |
b09a5592 PP |
69 | (*bt_component_class_filter_message_iterator_finalize_method)( |
70 | bt_self_message_iterator *message_iterator); | |
7b53201c | 71 | |
ee78f405 | 72 | typedef bt_self_message_iterator_status |
b09a5592 PP |
73 | (*bt_component_class_filter_message_iterator_next_method)( |
74 | bt_self_message_iterator *message_iterator, | |
75 | bt_message_array_const msgs, uint64_t capacity, | |
7b53201c PP |
76 | uint64_t *count); |
77 | ||
15a52f66 PP |
78 | typedef bt_self_message_iterator_status |
79 | (*bt_component_class_filter_message_iterator_seek_ns_from_origin_method)( | |
80 | bt_self_message_iterator *message_iterator, | |
81 | int64_t ns_from_origin); | |
82 | ||
83 | typedef bt_self_message_iterator_status | |
84 | (*bt_component_class_filter_message_iterator_seek_beginning_method)( | |
85 | bt_self_message_iterator *message_iterator); | |
86 | ||
87 | typedef bt_bool | |
88 | (*bt_component_class_filter_message_iterator_can_seek_ns_from_origin_method)( | |
89 | bt_self_message_iterator *message_iterator, | |
90 | int64_t ns_from_origin); | |
91 | ||
92 | typedef bt_bool | |
93 | (*bt_component_class_filter_message_iterator_can_seek_beginning_method)( | |
94 | bt_self_message_iterator *message_iterator); | |
95 | ||
ee78f405 | 96 | typedef bt_query_status |
7b53201c | 97 | (*bt_component_class_filter_query_method)( |
8eee8ea2 PP |
98 | bt_self_component_class_filter *comp_class, |
99 | const bt_query_executor *query_executor, | |
100 | const char *object, const bt_value *params, | |
101 | const bt_value **result); | |
7b53201c | 102 | |
ee78f405 | 103 | typedef bt_self_component_status |
7b53201c | 104 | (*bt_component_class_filter_accept_input_port_connection_method)( |
8eee8ea2 PP |
105 | bt_self_component_filter *self_component, |
106 | bt_self_component_port_input *self_port, | |
107 | const bt_port_output *other_port); | |
7b53201c | 108 | |
ee78f405 | 109 | typedef bt_self_component_status |
7b53201c | 110 | (*bt_component_class_filter_accept_output_port_connection_method)( |
8eee8ea2 PP |
111 | bt_self_component_filter *self_component, |
112 | bt_self_component_port_output *self_port, | |
113 | const bt_port_input *other_port); | |
7b53201c | 114 | |
ee78f405 | 115 | typedef bt_self_component_status |
7b53201c | 116 | (*bt_component_class_filter_input_port_connected_method)( |
8eee8ea2 PP |
117 | bt_self_component_filter *self_component, |
118 | bt_self_component_port_input *self_port, | |
119 | const bt_port_output *other_port); | |
7b53201c | 120 | |
ee78f405 | 121 | typedef bt_self_component_status |
7b53201c | 122 | (*bt_component_class_filter_output_port_connected_method)( |
8eee8ea2 PP |
123 | bt_self_component_filter *self_component, |
124 | bt_self_component_port_output *self_port, | |
125 | const bt_port_input *other_port); | |
7b53201c | 126 | |
834e9996 | 127 | static inline |
8eee8ea2 PP |
128 | bt_component_class *bt_component_class_filter_as_component_class( |
129 | bt_component_class_filter *comp_cls_filter) | |
834e9996 | 130 | { |
8470daa9 | 131 | return __BT_UPCAST(bt_component_class, comp_cls_filter); |
834e9996 | 132 | } |
d3eb6e8f | 133 | |
7b53201c | 134 | extern |
8eee8ea2 | 135 | bt_component_class_filter *bt_component_class_filter_create( |
7b53201c | 136 | const char *name, |
b09a5592 | 137 | bt_component_class_filter_message_iterator_next_method method); |
7b53201c | 138 | |
4d2e0cb5 PP |
139 | extern bt_component_class_status |
140 | bt_component_class_filter_set_init_method( | |
8eee8ea2 | 141 | bt_component_class_filter *comp_class, |
7b53201c PP |
142 | bt_component_class_filter_init_method method); |
143 | ||
4d2e0cb5 PP |
144 | extern bt_component_class_status |
145 | bt_component_class_filter_set_finalize_method( | |
8eee8ea2 | 146 | bt_component_class_filter *comp_class, |
7b53201c PP |
147 | bt_component_class_filter_finalize_method method); |
148 | ||
4d2e0cb5 PP |
149 | extern bt_component_class_status |
150 | bt_component_class_filter_set_accept_input_port_connection_method( | |
8eee8ea2 | 151 | bt_component_class_filter *comp_class, |
7b53201c PP |
152 | bt_component_class_filter_accept_input_port_connection_method method); |
153 | ||
4d2e0cb5 PP |
154 | extern bt_component_class_status |
155 | bt_component_class_filter_set_accept_output_port_connection_method( | |
8eee8ea2 | 156 | bt_component_class_filter *comp_class, |
7b53201c PP |
157 | bt_component_class_filter_accept_output_port_connection_method method); |
158 | ||
4d2e0cb5 PP |
159 | extern bt_component_class_status |
160 | bt_component_class_filter_set_input_port_connected_method( | |
8eee8ea2 | 161 | bt_component_class_filter *comp_class, |
7b53201c PP |
162 | bt_component_class_filter_input_port_connected_method method); |
163 | ||
4d2e0cb5 PP |
164 | extern bt_component_class_status |
165 | bt_component_class_filter_set_output_port_connected_method( | |
8eee8ea2 | 166 | bt_component_class_filter *comp_class, |
7b53201c PP |
167 | bt_component_class_filter_output_port_connected_method method); |
168 | ||
4d2e0cb5 PP |
169 | extern bt_component_class_status |
170 | bt_component_class_filter_set_query_method( | |
8eee8ea2 | 171 | bt_component_class_filter *comp_class, |
7b53201c PP |
172 | bt_component_class_filter_query_method method); |
173 | ||
4d2e0cb5 PP |
174 | extern bt_component_class_status |
175 | bt_component_class_filter_set_message_iterator_init_method( | |
8eee8ea2 | 176 | bt_component_class_filter *comp_class, |
b09a5592 | 177 | bt_component_class_filter_message_iterator_init_method method); |
7b53201c | 178 | |
4d2e0cb5 PP |
179 | extern bt_component_class_status |
180 | bt_component_class_filter_set_message_iterator_finalize_method( | |
8eee8ea2 | 181 | bt_component_class_filter *comp_class, |
b09a5592 | 182 | bt_component_class_filter_message_iterator_finalize_method method); |
7b53201c | 183 | |
15a52f66 PP |
184 | extern bt_component_class_status |
185 | bt_component_class_filter_set_message_iterator_seek_ns_from_origin_method( | |
186 | bt_component_class_filter *comp_class, | |
187 | bt_component_class_filter_message_iterator_seek_ns_from_origin_method method); | |
188 | ||
189 | extern bt_component_class_status | |
190 | bt_component_class_filter_set_message_iterator_seek_beginning_method( | |
191 | bt_component_class_filter *comp_class, | |
192 | bt_component_class_filter_message_iterator_seek_beginning_method method); | |
193 | ||
194 | extern bt_bool | |
195 | bt_component_class_filter_set_message_iterator_can_seek_ns_from_origin_method( | |
196 | bt_component_class_filter *comp_class, | |
197 | bt_component_class_filter_message_iterator_can_seek_ns_from_origin_method method); | |
198 | ||
199 | extern bt_bool | |
200 | bt_component_class_filter_set_message_iterator_can_seek_beginning_method( | |
201 | bt_component_class_filter *comp_class, | |
202 | bt_component_class_filter_message_iterator_can_seek_beginning_method method); | |
203 | ||
d3eb6e8f PP |
204 | #ifdef __cplusplus |
205 | } | |
206 | #endif | |
207 | ||
fe7265b5 | 208 | #endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_FILTER_H */ |