lib: remove "For *" comments in public headers
[babeltrace.git] / include / babeltrace2 / graph / self-component-filter.h
... / ...
CommitLineData
1#ifndef BABELTRACE2_GRAPH_SELF_COMPONENT_FILTER_H
2#define BABELTRACE2_GRAPH_SELF_COMPONENT_FILTER_H
3
4/*
5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
6 * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 * SOFTWARE.
25 */
26
27#ifndef __BT_IN_BABELTRACE_H
28# error "Please include <babeltrace2/babeltrace.h> instead."
29#endif
30
31#include <stdint.h>
32
33#include <babeltrace2/graph/self-component.h>
34#include <babeltrace2/types.h>
35
36#ifdef __cplusplus
37extern "C" {
38#endif
39
40static inline
41bt_self_component *bt_self_component_filter_as_self_component(
42 bt_self_component_filter *self_comp_filter)
43{
44 return __BT_UPCAST(bt_self_component, self_comp_filter);
45}
46
47static inline
48const bt_component_filter *
49bt_self_component_filter_as_component_filter(
50 bt_self_component_filter *self_comp_filter)
51{
52 return __BT_UPCAST_CONST(bt_component_filter, self_comp_filter);
53}
54
55extern bt_self_component_port_output *
56bt_self_component_filter_borrow_output_port_by_name(
57 bt_self_component_filter *self_component,
58 const char *name);
59
60extern bt_self_component_port_output *
61bt_self_component_filter_borrow_output_port_by_index(
62 bt_self_component_filter *self_component,
63 uint64_t index);
64
65extern bt_self_component_add_port_status
66bt_self_component_filter_add_output_port(
67 bt_self_component_filter *self_component,
68 const char *name, void *user_data,
69 bt_self_component_port_output **self_component_port);
70
71extern bt_self_component_port_input *
72bt_self_component_filter_borrow_input_port_by_name(
73 bt_self_component_filter *self_component,
74 const char *name);
75
76extern bt_self_component_port_input *
77bt_self_component_filter_borrow_input_port_by_index(
78 bt_self_component_filter *self_component,
79 uint64_t index);
80
81extern bt_self_component_add_port_status
82bt_self_component_filter_add_input_port(
83 bt_self_component_filter *self_component,
84 const char *name, void *user_data,
85 bt_self_component_port_input **self_component_port);
86
87#ifdef __cplusplus
88}
89#endif
90
91#endif /* BABELTRACE2_GRAPH_SELF_COMPONENT_FILTER_H */
This page took 0.043852 seconds and 4 git commands to generate.