ref.h: doc: fix typo
[babeltrace.git] / include / babeltrace / plugin / sink-internal.h
CommitLineData
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 33#include <babeltrace/plugin/plugin-system.h>
34a9ed19 34#include <babeltrace/plugin/input.h>
0d884c50 35
7c7c0433
JG
36struct bt_value;
37
fb2dcc52
JG
38struct bt_component_sink_class {
39 struct bt_component_class parent;
fb2dcc52
JG
40};
41
34a9ed19
JG
42//typedef uint32_t notification_mask_t;
43
0d884c50
JG
44struct bt_component_sink {
45 struct bt_component parent;
fec2a9f2
JG
46 bt_component_sink_consume_cb consume;
47 bt_component_sink_add_iterator_cb add_iterator;
34a9ed19 48 struct component_input input;
fec2a9f2 49/* notification_mask_t registered_notifications_mask;*/
0d884c50
JG
50};
51
8738a040
JG
52/**
53 * Allocate a sink component.
54 *
fb2dcc52 55 * @param class Component class
7c7c0433 56 * @param params A dictionary of component parameters
8738a040
JG
57 * @returns A sink component instance
58 */
59BT_HIDDEN
7c7c0433
JG
60struct bt_component *bt_component_sink_create(
61 struct bt_component_class *class, struct bt_value *params);
8738a040 62
92893b7b 63/**
7c7c0433 64 * Validate a sink component.
92893b7b 65 *
7c7c0433
JG
66 * @param component Sink component instance to validate
67 * @returns One of #bt_component_status
92893b7b 68 */
92893b7b 69BT_HIDDEN
7c7c0433
JG
70enum bt_component_status bt_component_sink_validate(
71 struct bt_component *component);
92893b7b 72
0d884c50 73#endif /* BABELTRACE_PLUGIN_SINK_INTERNAL_H */
This page took 0.028754 seconds and 4 git commands to generate.