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