Commit | Line | Data |
---|---|---|
33b34c43 PP |
1 | #ifndef BABELTRACE_COMPONENT_FILTER_H |
2 | #define BABELTRACE_COMPONENT_FILTER_H | |
34ac9eaf JG |
3 | |
4 | /* | |
5 | * BabelTrace - Filter Plug-in Interface | |
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 <stdint.h> | |
33b34c43 | 31 | #include <babeltrace/component/component.h> |
34ac9eaf JG |
32 | |
33 | #ifdef __cplusplus | |
34 | extern "C" { | |
35 | #endif | |
36 | ||
37 | struct bt_component; | |
38 | struct bt_notification_iterator; | |
39 | ||
40 | /** | |
41 | * Add a notification iterator to a filter component. | |
42 | * | |
43 | * @param component Component instance | |
44 | * @param iterator Notification iterator to add | |
45 | * @returns One of #bt_component_status values | |
46 | */ | |
34a9ed19 | 47 | extern |
34ac9eaf JG |
48 | enum bt_component_status bt_component_filter_add_iterator( |
49 | struct bt_component *component, | |
50 | struct bt_notification_iterator *iterator); | |
51 | ||
52 | /** | |
53 | * Create an iterator on a component instance. | |
54 | * | |
55 | * @param component Component instance | |
56 | * @returns Notification iterator instance | |
57 | */ | |
34a9ed19 | 58 | extern |
c725abdd | 59 | struct bt_notification_iterator *bt_component_filter_create_notification_iterator( |
34ac9eaf JG |
60 | struct bt_component *component); |
61 | ||
8b0ce102 | 62 | extern |
c725abdd | 63 | struct bt_notification_iterator *bt_component_filter_create_notification_iterator_with_init_method_data( |
8b0ce102 PP |
64 | struct bt_component *component, void *init_method_data); |
65 | ||
d3e4dcd8 PP |
66 | /* Defaults to 1. */ |
67 | extern enum bt_component_status | |
68 | bt_component_filter_set_minimum_input_count(struct bt_component *filter, | |
69 | unsigned int minimum); | |
70 | ||
71 | /* Defaults to 1. */ | |
72 | extern enum bt_component_status | |
73 | bt_component_filter_set_maximum_input_count(struct bt_component *filter, | |
74 | unsigned int maximum); | |
75 | ||
76 | extern enum bt_component_status | |
77 | bt_component_filter_get_input_count(struct bt_component *filter, | |
78 | unsigned int *count); | |
79 | ||
80 | /* May return NULL after an interator has reached its end. */ | |
81 | extern enum bt_component_status | |
82 | bt_component_filter_get_input_iterator(struct bt_component *filter, | |
83 | unsigned int input, struct bt_notification_iterator **iterator); | |
84 | ||
34ac9eaf JG |
85 | #ifdef __cplusplus |
86 | } | |
87 | #endif | |
88 | ||
33b34c43 | 89 | #endif /* BABELTRACE_COMPONENT_FILTER_H */ |