Commit | Line | Data |
---|---|---|
33b34c43 PP |
1 | #ifndef BABELTRACE_COMPONENT_FILTER_INTERNAL_H |
2 | #define BABELTRACE_COMPONENT_FILTER_INTERNAL_H | |
34ac9eaf JG |
3 | |
4 | /* | |
5 | * BabelTrace - Filter Component Internal | |
6 | * | |
7 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
8 | * | |
9 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
10 | * | |
11 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
12 | * of this software and associated documentation files (the "Software"), to deal | |
13 | * in the Software without restriction, including without limitation the rights | |
14 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
15 | * copies of the Software, and to permit persons to whom the Software is | |
16 | * furnished to do so, subject to the following conditions: | |
17 | * | |
18 | * The above copyright notice and this permission notice shall be included in | |
19 | * all copies or substantial portions of the Software. | |
20 | * | |
21 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
22 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
23 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
24 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
25 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
26 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
27 | * SOFTWARE. | |
28 | */ | |
29 | ||
30 | #include <babeltrace/babeltrace-internal.h> | |
33b34c43 PP |
31 | #include <babeltrace/component/component-internal.h> |
32 | #include <babeltrace/component/component-class-internal.h> | |
34ac9eaf JG |
33 | |
34 | struct bt_value; | |
35 | ||
34ac9eaf JG |
36 | struct bt_component_filter { |
37 | struct bt_component parent; | |
34ac9eaf JG |
38 | }; |
39 | ||
40 | /** | |
41 | * Allocate a filter component. | |
42 | * | |
43 | * @param class Component class | |
44 | * @param params A dictionary of component parameters | |
45 | * @returns A filter component instance | |
46 | */ | |
47 | BT_HIDDEN | |
48 | struct bt_component *bt_component_filter_create( | |
49 | struct bt_component_class *class, struct bt_value *params); | |
50 | ||
72b913fb PP |
51 | BT_HIDDEN |
52 | void bt_component_filter_destroy(struct bt_component *component); | |
53 | ||
34ac9eaf JG |
54 | /** |
55 | * Validate a filter component. | |
56 | * | |
57 | * @param component Filter component instance to validate | |
58 | * @returns One of #bt_component_status | |
59 | */ | |
60 | BT_HIDDEN | |
61 | enum bt_component_status bt_component_filter_validate( | |
62 | struct bt_component *component); | |
63 | ||
920b1d51 JG |
64 | /** |
65 | * Create an iterator on a component instance. | |
66 | * | |
67 | * @param component Component instance | |
68 | * @returns Notification iterator instance | |
69 | */ | |
70 | BT_HIDDEN | |
71 | struct bt_notification_iterator *bt_component_filter_create_notification_iterator( | |
72 | struct bt_component *component); | |
73 | ||
74 | BT_HIDDEN | |
75 | struct bt_notification_iterator *bt_component_filter_create_notification_iterator_with_init_method_data( | |
76 | struct bt_component *component, void *init_method_data); | |
77 | ||
33b34c43 | 78 | #endif /* BABELTRACE_COMPONENT_FILTER_INTERNAL_H */ |