projects / babeltrace.git / blame
| Commit | Line | Data |
|---|---|---|
| 0d884c50 JG |
1 | #ifndef BABELTRACE_PLUGIN_SINK_INTERNAL_H |
| 2 | #define BABELTRACE_PLUGIN_SINK_INTERNAL_H | |
| 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> | |
| 31 | #include <babeltrace/plugin/component-internal.h> | |
| fb2dcc52 | 32 | #include <babeltrace/plugin/component-class-internal.h> |
| 0d884c50 JG |
33 | #include <babeltrace/plugin/plugin-system.h> |
| 34 | ||
| 7c7c0433 JG |
35 | struct bt_value; |
| 36 | ||
| fb2dcc52 JG |
37 | struct bt_component_sink_class { |
| 38 | struct bt_component_class parent; | |
| fb2dcc52 JG |
39 | }; |
| 40 | ||
| 30d619df | 41 | typedef uint32_t notification_mask_t; |
| 0d884c50 JG |
42 | struct bt_component_sink { |
| 43 | struct bt_component parent; | |
| 44 | ||
| 45 | /* Component implementation callbacks */ | |
| 46 | bt_component_sink_handle_notification_cb handle_notification; | |
| 30d619df | 47 | notification_mask_t registered_notifications_mask; |
| 0d884c50 JG |
48 | }; |
| 49 | ||
| 8738a040 JG |
50 | /** |
| 51 | * Allocate a sink component. | |
| 52 | * | |
| fb2dcc52 | 53 | * @param class Component class |
| 7c7c0433 | 54 | * @param params A dictionary of component parameters |
| 8738a040 JG |
55 | * @returns A sink component instance |
| 56 | */ | |
| 57 | BT_HIDDEN | |
| 7c7c0433 JG |
58 | struct bt_component *bt_component_sink_create( |
| 59 | struct bt_component_class *class, struct bt_value *params); | |
| 8738a040 | 60 | |
| 92893b7b | 61 | /** |
| 7c7c0433 | 62 | * Validate a sink component. |
| 92893b7b | 63 | * |
| 7c7c0433 JG |
64 | * @param component Sink component instance to validate |
| 65 | * @returns One of #bt_component_status | |
| 92893b7b | 66 | */ |
| 92893b7b | 67 | BT_HIDDEN |
| 7c7c0433 JG |
68 | enum bt_component_status bt_component_sink_validate( |
| 69 | struct bt_component *component); | |
| 92893b7b | 70 | |
| 0d884c50 | 71 | #endif /* BABELTRACE_PLUGIN_SINK_INTERNAL_H */ |