projects / babeltrace.git / blame
| Commit | Line | Data |
|---|---|---|
| 33b34c43 PP |
1 | #ifndef BABELTRACE_COMPONENT_SINK_H |
| 2 | #define BABELTRACE_COMPONENT_SINK_H | |
| 584e4e78 JG |
3 | |
| 4 | /* | |
| 633edee0 | 5 | * BabelTrace - Sink Component Interface |
| 584e4e78 | 6 | * |
| 366e034f | 7 | * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
| 584e4e78 JG |
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 | ||
| 33b34c43 | 30 | #include <babeltrace/component/component.h> |
| f3bc2010 | 31 | |
| 584e4e78 JG |
32 | #ifdef __cplusplus |
| 33 | extern "C" { | |
| 34 | #endif | |
| 35 | ||
| cc37910d JG |
36 | struct bt_component; |
| 37 | struct bt_notification; | |
| 38 | ||
| fec2a9f2 JG |
39 | /** |
| 40 | * Process one event, consuming from sources as needed. | |
| 41 | * | |
| 42 | * @param component Component instance | |
| 43 | * @returns One of #bt_component_status values | |
| 44 | */ | |
| 34a9ed19 | 45 | extern |
| fec2a9f2 JG |
46 | enum bt_component_status bt_component_sink_consume( |
| 47 | struct bt_component *component); | |
| 584e4e78 | 48 | |
| 366e034f JG |
49 | extern int bt_component_sink_get_input_port_count( |
| 50 | struct bt_component *component); | |
| 51 | extern struct bt_port *bt_component_sink_get_input_port( | |
| 52 | struct bt_component *component, const char *name); | |
| 53 | extern struct bt_port *bt_component_sink_get_input_port_at_index( | |
| 54 | struct bt_component *component, int index); | |
| d3e4dcd8 | 55 | |
| 366e034f JG |
56 | /* Only allowed during the sink's initialization. */ |
| 57 | extern struct bt_port *bt_component_sink_add_input_port( | |
| 58 | struct bt_component *component, const char *name); | |
| 59 | /* Only allowed during the sink's initialization. */ | |
| 60 | extern enum bt_component_status bt_component_sink_remove_input_port( | |
| 61 | struct bt_component *component, const char *name); | |
| 62 | extern struct bt_port *bt_component_sink_get_default_input_port( | |
| 63 | struct bt_component *component); | |
| d3e4dcd8 | 64 | |
| 584e4e78 JG |
65 | #ifdef __cplusplus |
| 66 | } | |
| 67 | #endif | |
| 68 | ||
| 33b34c43 | 69 | #endif /* BABELTRACE_COMPONENT_SINK_H */ |