bt2: by-pass distutils changed file check
[babeltrace.git] / include / babeltrace / graph / component-sink-internal.h
CommitLineData
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>
b2e0c907
PP
31#include <babeltrace/graph/component-sink.h>
32#include <babeltrace/graph/component-internal.h>
33#include <babeltrace/graph/component-class-internal.h>
0d884c50 34
7c7c0433
JG
35struct bt_value;
36
34a9ed19
JG
37//typedef uint32_t notification_mask_t;
38
0d884c50
JG
39struct bt_component_sink {
40 struct bt_component parent;
0d884c50
JG
41};
42
8738a040
JG
43/**
44 * Allocate a sink component.
45 *
fb2dcc52 46 * @param class Component class
7c7c0433 47 * @param params A dictionary of component parameters
8738a040
JG
48 * @returns A sink component instance
49 */
50BT_HIDDEN
7c7c0433 51struct bt_component *bt_component_sink_create(
36712f1d 52 struct bt_component_class *class);
8738a040 53
72b913fb
PP
54BT_HIDDEN
55void bt_component_sink_destroy(struct bt_component *component);
56
973a2bd1
JG
57/**
58 * Process one event, consuming from sources as needed.
59 *
60 * @param component Component instance
61 * @returns One of #bt_component_status values
62 */
63BT_HIDDEN
64enum bt_component_status bt_component_sink_consume(
65 struct bt_component *component);
66
33b34c43 67#endif /* BABELTRACE_COMPONENT_SINK_INTERNAL_H */
This page took 0.038525 seconds and 4 git commands to generate.