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