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 | /* | |
e2f7325d | 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 | ||
0d72b8c3 PP |
27 | #include <stdint.h> |
28 | ||
4cdfc5e8 | 29 | /* For bt_self_component_status */ |
3fadfbc0 | 30 | #include <babeltrace2/graph/self-component.h> |
0d72b8c3 | 31 | |
4cdfc5e8 | 32 | /* For bt_self_message_iterator_status */ |
3fadfbc0 | 33 | #include <babeltrace2/graph/self-message-iterator.h> |
0d72b8c3 | 34 | |
4cdfc5e8 | 35 | /* For bt_query_status */ |
3fadfbc0 | 36 | #include <babeltrace2/graph/component-class.h> |
0d72b8c3 | 37 | |
d0cf29ee | 38 | /* For bt_component_class_status */ |
3fadfbc0 | 39 | #include <babeltrace2/graph/component-class-const.h> |
d0cf29ee | 40 | |
b19ff26f 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, | |
7474e7d3 | 45 | * bt_self_component_port_output, bt_value, bt_message_array_const, |
005f1204 | 46 | * bt_bool, bt_self_message_iterator, __BT_UPCAST |
b19ff26f | 47 | */ |
3fadfbc0 | 48 | #include <babeltrace2/types.h> |
b19ff26f | 49 | |
f4e38e70 PP |
50 | /* For bt_logging_level */ |
51 | #include <babeltrace2/logging.h> | |
52 | ||
d3e4dcd8 PP |
53 | #ifdef __cplusplus |
54 | extern "C" { | |
55 | #endif | |
56 | ||
4cdfc5e8 | 57 | typedef bt_self_component_status |
0d72b8c3 | 58 | (*bt_component_class_filter_init_method)( |
b19ff26f PP |
59 | bt_self_component_filter *self_component, |
60 | const bt_value *params, void *init_method_data); | |
0d72b8c3 PP |
61 | |
62 | typedef void (*bt_component_class_filter_finalize_method)( | |
b19ff26f | 63 | bt_self_component_filter *self_component); |
0d72b8c3 | 64 | |
4cdfc5e8 | 65 | typedef bt_self_message_iterator_status |
d6e69534 PP |
66 | (*bt_component_class_filter_message_iterator_init_method)( |
67 | bt_self_message_iterator *message_iterator, | |
b19ff26f PP |
68 | bt_self_component_filter *self_component, |
69 | bt_self_component_port_output *port); | |
0d72b8c3 PP |
70 | |
71 | typedef void | |
d6e69534 PP |
72 | (*bt_component_class_filter_message_iterator_finalize_method)( |
73 | bt_self_message_iterator *message_iterator); | |
0d72b8c3 | 74 | |
4cdfc5e8 | 75 | typedef bt_self_message_iterator_status |
d6e69534 PP |
76 | (*bt_component_class_filter_message_iterator_next_method)( |
77 | bt_self_message_iterator *message_iterator, | |
78 | bt_message_array_const msgs, uint64_t capacity, | |
0d72b8c3 PP |
79 | uint64_t *count); |
80 | ||
7474e7d3 PP |
81 | typedef bt_self_message_iterator_status |
82 | (*bt_component_class_filter_message_iterator_seek_ns_from_origin_method)( | |
83 | bt_self_message_iterator *message_iterator, | |
84 | int64_t ns_from_origin); | |
85 | ||
86 | typedef bt_self_message_iterator_status | |
87 | (*bt_component_class_filter_message_iterator_seek_beginning_method)( | |
88 | bt_self_message_iterator *message_iterator); | |
89 | ||
90 | typedef bt_bool | |
91 | (*bt_component_class_filter_message_iterator_can_seek_ns_from_origin_method)( | |
92 | bt_self_message_iterator *message_iterator, | |
93 | int64_t ns_from_origin); | |
94 | ||
95 | typedef bt_bool | |
96 | (*bt_component_class_filter_message_iterator_can_seek_beginning_method)( | |
97 | bt_self_message_iterator *message_iterator); | |
98 | ||
4cdfc5e8 | 99 | typedef bt_query_status |
0d72b8c3 | 100 | (*bt_component_class_filter_query_method)( |
b19ff26f PP |
101 | bt_self_component_class_filter *comp_class, |
102 | const bt_query_executor *query_executor, | |
103 | const char *object, const bt_value *params, | |
f4e38e70 | 104 | bt_logging_level logging_level, const bt_value **result); |
0d72b8c3 | 105 | |
4cdfc5e8 | 106 | typedef bt_self_component_status |
0d72b8c3 | 107 | (*bt_component_class_filter_input_port_connected_method)( |
b19ff26f PP |
108 | bt_self_component_filter *self_component, |
109 | bt_self_component_port_input *self_port, | |
110 | const bt_port_output *other_port); | |
0d72b8c3 | 111 | |
4cdfc5e8 | 112 | typedef bt_self_component_status |
0d72b8c3 | 113 | (*bt_component_class_filter_output_port_connected_method)( |
b19ff26f PP |
114 | bt_self_component_filter *self_component, |
115 | bt_self_component_port_output *self_port, | |
116 | const bt_port_input *other_port); | |
0d72b8c3 | 117 | |
d94d92ac | 118 | static inline |
b19ff26f PP |
119 | bt_component_class *bt_component_class_filter_as_component_class( |
120 | bt_component_class_filter *comp_cls_filter) | |
d94d92ac | 121 | { |
005f1204 | 122 | return __BT_UPCAST(bt_component_class, comp_cls_filter); |
d94d92ac | 123 | } |
d3eb6e8f | 124 | |
0d72b8c3 | 125 | extern |
b19ff26f | 126 | bt_component_class_filter *bt_component_class_filter_create( |
0d72b8c3 | 127 | const char *name, |
d6e69534 | 128 | bt_component_class_filter_message_iterator_next_method method); |
0d72b8c3 | 129 | |
d0cf29ee PP |
130 | extern bt_component_class_status |
131 | bt_component_class_filter_set_init_method( | |
b19ff26f | 132 | bt_component_class_filter *comp_class, |
0d72b8c3 PP |
133 | bt_component_class_filter_init_method method); |
134 | ||
d0cf29ee PP |
135 | extern bt_component_class_status |
136 | bt_component_class_filter_set_finalize_method( | |
b19ff26f | 137 | bt_component_class_filter *comp_class, |
0d72b8c3 PP |
138 | bt_component_class_filter_finalize_method method); |
139 | ||
d0cf29ee PP |
140 | extern bt_component_class_status |
141 | bt_component_class_filter_set_input_port_connected_method( | |
b19ff26f | 142 | bt_component_class_filter *comp_class, |
0d72b8c3 PP |
143 | bt_component_class_filter_input_port_connected_method method); |
144 | ||
d0cf29ee PP |
145 | extern bt_component_class_status |
146 | bt_component_class_filter_set_output_port_connected_method( | |
b19ff26f | 147 | bt_component_class_filter *comp_class, |
0d72b8c3 PP |
148 | bt_component_class_filter_output_port_connected_method method); |
149 | ||
d0cf29ee PP |
150 | extern bt_component_class_status |
151 | bt_component_class_filter_set_query_method( | |
b19ff26f | 152 | bt_component_class_filter *comp_class, |
0d72b8c3 PP |
153 | bt_component_class_filter_query_method method); |
154 | ||
d0cf29ee PP |
155 | extern bt_component_class_status |
156 | bt_component_class_filter_set_message_iterator_init_method( | |
b19ff26f | 157 | bt_component_class_filter *comp_class, |
d6e69534 | 158 | bt_component_class_filter_message_iterator_init_method method); |
0d72b8c3 | 159 | |
d0cf29ee PP |
160 | extern bt_component_class_status |
161 | bt_component_class_filter_set_message_iterator_finalize_method( | |
b19ff26f | 162 | bt_component_class_filter *comp_class, |
d6e69534 | 163 | bt_component_class_filter_message_iterator_finalize_method method); |
0d72b8c3 | 164 | |
7474e7d3 PP |
165 | extern bt_component_class_status |
166 | bt_component_class_filter_set_message_iterator_seek_ns_from_origin_method( | |
167 | bt_component_class_filter *comp_class, | |
168 | bt_component_class_filter_message_iterator_seek_ns_from_origin_method method); | |
169 | ||
170 | extern bt_component_class_status | |
171 | bt_component_class_filter_set_message_iterator_seek_beginning_method( | |
172 | bt_component_class_filter *comp_class, | |
173 | bt_component_class_filter_message_iterator_seek_beginning_method method); | |
174 | ||
175 | extern bt_bool | |
176 | bt_component_class_filter_set_message_iterator_can_seek_ns_from_origin_method( | |
177 | bt_component_class_filter *comp_class, | |
178 | bt_component_class_filter_message_iterator_can_seek_ns_from_origin_method method); | |
179 | ||
180 | extern bt_bool | |
181 | bt_component_class_filter_set_message_iterator_can_seek_beginning_method( | |
182 | bt_component_class_filter *comp_class, | |
183 | bt_component_class_filter_message_iterator_can_seek_beginning_method method); | |
184 | ||
d3eb6e8f PP |
185 | #ifdef __cplusplus |
186 | } | |
187 | #endif | |
188 | ||
90157d89 | 189 | #endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_FILTER_H */ |