projects / babeltrace.git / blame
| Commit | Line | Data |
|---|---|---|
| 33b34c43 PP |
1 | #ifndef BABELTRACE_COMPONENT_SINK_INTERNAL_H |
| 2 | #define BABELTRACE_COMPONENT_SINK_INTERNAL_H | |
| 0d884c50 JG |
3 | |
| 4 | /* | |
| 5 | * BabelTrace - Sink Component internal | |
| 6 | * | |
| 7 | * Copyright 2015 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> | |
| 91c1f164 | 31 | #include <babeltrace/component/component-sink.h> |
| 33b34c43 PP |
32 | #include <babeltrace/component/component-internal.h> |
| 33 | #include <babeltrace/component/component-class-internal.h> | |
| 0d884c50 | 34 | |
| 7c7c0433 JG |
35 | struct bt_value; |
| 36 | ||
| 34a9ed19 JG |
37 | //typedef uint32_t notification_mask_t; |
| 38 | ||
| 0d884c50 JG |
39 | struct bt_component_sink { |
| 40 | struct bt_component parent; | |
| 366e034f | 41 | GPtrArray *input_ports; |
| fec2a9f2 | 42 | /* notification_mask_t registered_notifications_mask;*/ |
| 0d884c50 JG |
43 | }; |
| 44 | ||
| 8738a040 JG |
45 | /** |
| 46 | * Allocate a sink component. | |
| 47 | * | |
| fb2dcc52 | 48 | * @param class Component class |
| 7c7c0433 | 49 | * @param params A dictionary of component parameters |
| 8738a040 JG |
50 | * @returns A sink component instance |
| 51 | */ | |
| 52 | BT_HIDDEN | |
| 7c7c0433 JG |
53 | struct bt_component *bt_component_sink_create( |
| 54 | struct bt_component_class *class, struct bt_value *params); | |
| 8738a040 | 55 | |
| 92893b7b | 56 | /** |
| 7c7c0433 | 57 | * Validate a sink component. |
| 92893b7b | 58 | * |
| 7c7c0433 JG |
59 | * @param component Sink component instance to validate |
| 60 | * @returns One of #bt_component_status | |
| 92893b7b | 61 | */ |
| 92893b7b | 62 | BT_HIDDEN |
| 7c7c0433 JG |
63 | enum bt_component_status bt_component_sink_validate( |
| 64 | struct bt_component *component); | |
| 92893b7b | 65 | |
| 973a2bd1 JG |
66 | /** |
| 67 | * Process one event, consuming from sources as needed. | |
| 68 | * | |
| 69 | * @param component Component instance | |
| 70 | * @returns One of #bt_component_status values | |
| 71 | */ | |
| 72 | BT_HIDDEN | |
| 73 | enum bt_component_status bt_component_sink_consume( | |
| 74 | struct bt_component *component); | |
| 75 | ||
| 33b34c43 | 76 | #endif /* BABELTRACE_COMPONENT_SINK_INTERNAL_H */ |