1 #ifndef BABELTRACE_COMPONENT_SINK_H
2 #define BABELTRACE_COMPONENT_SINK_H
5 * BabelTrace - Sink Component Interface
7 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
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:
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
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
30 #include <babeltrace/component/component.h>
37 struct bt_notification
;
40 * Add a notification iterator to a sink component.
42 * @param component Component instance
43 * @param iterator Notification iterator to add
44 * @returns One of #bt_component_status values
47 enum bt_component_status
bt_component_sink_add_iterator(
48 struct bt_component
*component
,
49 struct bt_notification_iterator
*iterator
);
52 * Process one event, consuming from sources as needed.
54 * @param component Component instance
55 * @returns One of #bt_component_status values
58 enum bt_component_status
bt_component_sink_consume(
59 struct bt_component
*component
);
62 extern enum bt_component_status
63 bt_component_sink_set_minimum_input_count(struct bt_component
*sink
,
64 unsigned int minimum
);
67 extern enum bt_component_status
68 bt_component_sink_set_maximum_input_count(struct bt_component
*sink
,
69 unsigned int maximum
);
71 extern enum bt_component_status
72 bt_component_sink_get_input_count(struct bt_component
*sink
,
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
);
84 #endif /* BABELTRACE_COMPONENT_SINK_H */
This page took 0.031703 seconds and 4 git commands to generate.