tests/lib: remove `test_bt_values` and `test_graph_topo`
[babeltrace.git] / include / babeltrace2 / graph / component-class-filter.h
CommitLineData
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
83da519a
PP
50/* For bt_logging_level */
51#include <babeltrace2/logging.h>
52
d3e4dcd8
PP
53#ifdef __cplusplus
54extern "C" {
55#endif
56
ee78f405 57typedef bt_self_component_status
7b53201c 58(*bt_component_class_filter_init_method)(
8eee8ea2
PP
59 bt_self_component_filter *self_component,
60 const bt_value *params, void *init_method_data);
7b53201c
PP
61
62typedef void (*bt_component_class_filter_finalize_method)(
8eee8ea2 63 bt_self_component_filter *self_component);
7b53201c 64
ee78f405 65typedef bt_self_message_iterator_status
b09a5592
PP
66(*bt_component_class_filter_message_iterator_init_method)(
67 bt_self_message_iterator *message_iterator,
8eee8ea2
PP
68 bt_self_component_filter *self_component,
69 bt_self_component_port_output *port);
7b53201c
PP
70
71typedef void
b09a5592
PP
72(*bt_component_class_filter_message_iterator_finalize_method)(
73 bt_self_message_iterator *message_iterator);
7b53201c 74
ee78f405 75typedef bt_self_message_iterator_status
b09a5592
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,
7b53201c
PP
79 uint64_t *count);
80
15a52f66
PP
81typedef 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
86typedef bt_self_message_iterator_status
87(*bt_component_class_filter_message_iterator_seek_beginning_method)(
88 bt_self_message_iterator *message_iterator);
89
90typedef 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
95typedef bt_bool
96(*bt_component_class_filter_message_iterator_can_seek_beginning_method)(
97 bt_self_message_iterator *message_iterator);
98
ee78f405 99typedef bt_query_status
7b53201c 100(*bt_component_class_filter_query_method)(
8eee8ea2
PP
101 bt_self_component_class_filter *comp_class,
102 const bt_query_executor *query_executor,
103 const char *object, const bt_value *params,
83da519a 104 bt_logging_level logging_level, const bt_value **result);
7b53201c 105
ee78f405 106typedef bt_self_component_status
7b53201c 107(*bt_component_class_filter_input_port_connected_method)(
8eee8ea2
PP
108 bt_self_component_filter *self_component,
109 bt_self_component_port_input *self_port,
110 const bt_port_output *other_port);
7b53201c 111
ee78f405 112typedef bt_self_component_status
7b53201c 113(*bt_component_class_filter_output_port_connected_method)(
8eee8ea2
PP
114 bt_self_component_filter *self_component,
115 bt_self_component_port_output *self_port,
116 const bt_port_input *other_port);
7b53201c 117
834e9996 118static inline
8eee8ea2
PP
119bt_component_class *bt_component_class_filter_as_component_class(
120 bt_component_class_filter *comp_cls_filter)
834e9996 121{
8470daa9 122 return __BT_UPCAST(bt_component_class, comp_cls_filter);
834e9996 123}
d3eb6e8f 124
7b53201c 125extern
8eee8ea2 126bt_component_class_filter *bt_component_class_filter_create(
7b53201c 127 const char *name,
b09a5592 128 bt_component_class_filter_message_iterator_next_method method);
7b53201c 129
4d2e0cb5
PP
130extern bt_component_class_status
131bt_component_class_filter_set_init_method(
8eee8ea2 132 bt_component_class_filter *comp_class,
7b53201c
PP
133 bt_component_class_filter_init_method method);
134
4d2e0cb5
PP
135extern bt_component_class_status
136bt_component_class_filter_set_finalize_method(
8eee8ea2 137 bt_component_class_filter *comp_class,
7b53201c
PP
138 bt_component_class_filter_finalize_method method);
139
4d2e0cb5
PP
140extern bt_component_class_status
141bt_component_class_filter_set_input_port_connected_method(
8eee8ea2 142 bt_component_class_filter *comp_class,
7b53201c
PP
143 bt_component_class_filter_input_port_connected_method method);
144
4d2e0cb5
PP
145extern bt_component_class_status
146bt_component_class_filter_set_output_port_connected_method(
8eee8ea2 147 bt_component_class_filter *comp_class,
7b53201c
PP
148 bt_component_class_filter_output_port_connected_method method);
149
4d2e0cb5
PP
150extern bt_component_class_status
151bt_component_class_filter_set_query_method(
8eee8ea2 152 bt_component_class_filter *comp_class,
7b53201c
PP
153 bt_component_class_filter_query_method method);
154
4d2e0cb5
PP
155extern bt_component_class_status
156bt_component_class_filter_set_message_iterator_init_method(
8eee8ea2 157 bt_component_class_filter *comp_class,
b09a5592 158 bt_component_class_filter_message_iterator_init_method method);
7b53201c 159
4d2e0cb5
PP
160extern bt_component_class_status
161bt_component_class_filter_set_message_iterator_finalize_method(
8eee8ea2 162 bt_component_class_filter *comp_class,
b09a5592 163 bt_component_class_filter_message_iterator_finalize_method method);
7b53201c 164
15a52f66
PP
165extern bt_component_class_status
166bt_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
170extern bt_component_class_status
171bt_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
175extern bt_bool
176bt_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
180extern bt_bool
181bt_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
fe7265b5 189#endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_FILTER_H */
This page took 0.058921 seconds and 4 git commands to generate.