1 #ifndef BABELTRACE2_GRAPH_COMPONENT_CLASS_FILTER_H
2 #define BABELTRACE2_GRAPH_COMPONENT_CLASS_FILTER_H
5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
6 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
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:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
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
27 #ifndef __BT_IN_BABELTRACE_H
28 # error "Please include <babeltrace2/babeltrace.h> instead."
33 /* For bt_component_class_*_status */
34 #include <babeltrace2/graph/component-class.h>
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,
40 * bt_self_component_port_output, bt_value, bt_message_array_const,
41 * bt_bool, bt_self_message_iterator, __BT_UPCAST
43 #include <babeltrace2/types.h>
45 /* For bt_logging_level */
46 #include <babeltrace2/logging.h>
52 typedef bt_component_class_init_method_status
53 (*bt_component_class_filter_init_method
)(
54 bt_self_component_filter
*self_component
,
55 const bt_value
*params
, void *init_method_data
);
57 typedef void (*bt_component_class_filter_finalize_method
)(
58 bt_self_component_filter
*self_component
);
60 typedef bt_component_class_message_iterator_init_method_status
61 (*bt_component_class_filter_message_iterator_init_method
)(
62 bt_self_message_iterator
*message_iterator
,
63 bt_self_component_filter
*self_component
,
64 bt_self_component_port_output
*port
);
67 (*bt_component_class_filter_message_iterator_finalize_method
)(
68 bt_self_message_iterator
*message_iterator
);
70 typedef bt_component_class_message_iterator_next_method_status
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
,
76 typedef bt_component_class_message_iterator_seek_ns_from_origin_method_status
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
);
81 typedef bt_component_class_message_iterator_seek_beginning_method_status
82 (*bt_component_class_filter_message_iterator_seek_beginning_method
)(
83 bt_self_message_iterator
*message_iterator
);
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
);
91 (*bt_component_class_filter_message_iterator_can_seek_beginning_method
)(
92 bt_self_message_iterator
*message_iterator
);
94 typedef bt_component_class_query_method_status
95 (*bt_component_class_filter_query_method
)(
96 bt_self_component_class_filter
*comp_class
,
97 const bt_query_executor
*query_executor
,
98 const char *object
, const bt_value
*params
,
99 bt_logging_level logging_level
, const bt_value
**result
);
101 typedef bt_component_class_port_connected_method_status
102 (*bt_component_class_filter_input_port_connected_method
)(
103 bt_self_component_filter
*self_component
,
104 bt_self_component_port_input
*self_port
,
105 const bt_port_output
*other_port
);
107 typedef bt_component_class_port_connected_method_status
108 (*bt_component_class_filter_output_port_connected_method
)(
109 bt_self_component_filter
*self_component
,
110 bt_self_component_port_output
*self_port
,
111 const bt_port_input
*other_port
);
114 bt_component_class
*bt_component_class_filter_as_component_class(
115 bt_component_class_filter
*comp_cls_filter
)
117 return __BT_UPCAST(bt_component_class
, comp_cls_filter
);
121 bt_component_class_filter
*bt_component_class_filter_create(
123 bt_component_class_filter_message_iterator_next_method method
);
125 extern bt_component_class_set_method_status
126 bt_component_class_filter_set_init_method(
127 bt_component_class_filter
*comp_class
,
128 bt_component_class_filter_init_method method
);
130 extern bt_component_class_set_method_status
131 bt_component_class_filter_set_finalize_method(
132 bt_component_class_filter
*comp_class
,
133 bt_component_class_filter_finalize_method method
);
135 extern bt_component_class_set_method_status
136 bt_component_class_filter_set_input_port_connected_method(
137 bt_component_class_filter
*comp_class
,
138 bt_component_class_filter_input_port_connected_method method
);
140 extern bt_component_class_set_method_status
141 bt_component_class_filter_set_output_port_connected_method(
142 bt_component_class_filter
*comp_class
,
143 bt_component_class_filter_output_port_connected_method method
);
145 extern bt_component_class_set_method_status
146 bt_component_class_filter_set_query_method(
147 bt_component_class_filter
*comp_class
,
148 bt_component_class_filter_query_method method
);
150 extern bt_component_class_set_method_status
151 bt_component_class_filter_set_message_iterator_init_method(
152 bt_component_class_filter
*comp_class
,
153 bt_component_class_filter_message_iterator_init_method method
);
155 extern bt_component_class_set_method_status
156 bt_component_class_filter_set_message_iterator_finalize_method(
157 bt_component_class_filter
*comp_class
,
158 bt_component_class_filter_message_iterator_finalize_method method
);
160 extern bt_component_class_set_method_status
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
);
165 extern bt_component_class_set_method_status
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
);
170 extern bt_component_class_set_method_status
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
);
175 extern bt_component_class_set_method_status
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
);
184 #endif /* BABELTRACE2_GRAPH_COMPONENT_CLASS_FILTER_H */