Add base plug-in skeletons
[babeltrace.git] / include / babeltrace / plugin / sink.h
... / ...
CommitLineData
1#ifndef BABELTRACE_PLUGIN_COMPONENT_SINK_H
2#define BABELTRACE_PLUGIN_COMPONENT_SINK_H
3
4/*
5 * BabelTrace - Sink Component Interface
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/plugin/component.h>
31
32#ifdef __cplusplus
33extern "C" {
34#endif
35
36struct bt_component;
37struct bt_notification;
38
39/**
40 * Hand-off a notification to a sink component.
41 *
42 * @param component Component instance
43 * @param notification Notification instance to handle
44 * @returns One of #bt_component_status values
45 */
46enum bt_component_status bt_component_sink_handle_notification(
47 struct bt_component *component,
48 struct bt_notification *notification);
49
50#ifdef __cplusplus
51}
52#endif
53
54#endif /* BABELTRACE_PLUGIN_COMPONENT_SINK_H */
This page took 0.024274 seconds and 4 git commands to generate.