List detected component classes
[babeltrace.git] / include / babeltrace / plugin / sink.h
CommitLineData
633edee0
JG
1#ifndef BABELTRACE_PLUGIN_COMPONENT_SINK_H
2#define BABELTRACE_PLUGIN_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
584e4e78
JG
30#ifdef __cplusplus
31extern "C" {
32#endif
33
cc37910d
JG
34struct bt_component;
35struct bt_notification;
36
584e4e78 37/**
633edee0 38 * Hand-off a notification to a sink component.
584e4e78 39 *
633edee0 40 * @param component Component instance
cc37910d 41 * @param notification Notification instance to handle
633edee0 42 * @returns One of #bt_component_status values
584e4e78 43 */
633edee0 44enum bt_component_status bt_component_sink_handle_notification(
cc37910d
JG
45 struct bt_component *component,
46 struct bt_notification *notification);
584e4e78
JG
47
48#ifdef __cplusplus
49}
50#endif
51
633edee0 52#endif /* BABELTRACE_PLUGIN_COMPONENT_SINK_H */
This page took 0.025138 seconds and 4 git commands to generate.