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 JG |
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 | ||
| 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 | ||
| 584e4e78 | 39 | /** |
| fec2a9f2 | 40 | * Add a notification iterator to a sink component. |
| 584e4e78 | 41 | * |
| 633edee0 | 42 | * @param component Component instance |
| fec2a9f2 | 43 | * @param iterator Notification iterator to add |
| 633edee0 | 44 | * @returns One of #bt_component_status values |
| 584e4e78 | 45 | */ |
| 34a9ed19 | 46 | extern |
| fec2a9f2 | 47 | enum bt_component_status bt_component_sink_add_iterator( |
| cc37910d | 48 | struct bt_component *component, |
| fec2a9f2 JG |
49 | struct bt_notification_iterator *iterator); |
| 50 | ||
| 51 | /** | |
| 52 | * Process one event, consuming from sources as needed. | |
| 53 | * | |
| 54 | * @param component Component instance | |
| 55 | * @returns One of #bt_component_status values | |
| 56 | */ | |
| 34a9ed19 | 57 | extern |
| fec2a9f2 JG |
58 | enum bt_component_status bt_component_sink_consume( |
| 59 | struct bt_component *component); | |
| 584e4e78 | 60 | |
| d3e4dcd8 PP |
61 | /* Defaults to 1. */ |
| 62 | extern enum bt_component_status | |
| 63 | bt_component_sink_set_minimum_input_count(struct bt_component *sink, | |
| 64 | unsigned int minimum); | |
| 65 | ||
| 66 | /* Defaults to 1. */ | |
| 67 | extern enum bt_component_status | |
| 68 | bt_component_sink_set_maximum_input_count(struct bt_component *sink, | |
| 69 | unsigned int maximum); | |
| 70 | ||
| 71 | extern enum bt_component_status | |
| 72 | bt_component_sink_get_input_count(struct bt_component *sink, | |
| 73 | unsigned int *count); | |
| 74 | ||
| 75 | /* May return NULL after an interator has reached its end. */ | |
| 76 | extern enum bt_component_status | |
| 77 | bt_component_sink_get_input_iterator(struct bt_component *sink, | |
| 78 | unsigned int input, struct bt_notification_iterator **iterator); | |
| 79 | ||
| 584e4e78 JG |
80 | #ifdef __cplusplus |
| 81 | } | |
| 82 | #endif | |
| 83 | ||
| 33b34c43 | 84 | #endif /* BABELTRACE_COMPONENT_SINK_H */ |