lib: remove "For *" comments in public headers
[babeltrace.git] / include / babeltrace2 / graph / self-component-port.h
1 #ifndef BABELTRACE2_GRAPH_SELF_COMPONENT_PORT_H
2 #define BABELTRACE2_GRAPH_SELF_COMPONENT_PORT_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 <babeltrace2/types.h>
31
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35
36 typedef enum bt_self_component_port_status {
37 BT_SELF_PORT_STATUS_OK = 0,
38 } bt_self_component_port_status;
39
40 static inline
41 const bt_port *bt_self_component_port_as_port(
42 bt_self_component_port *self_port)
43 {
44 return __BT_UPCAST_CONST(bt_port, self_port);
45 }
46
47 extern bt_self_component *bt_self_component_port_borrow_component(
48 bt_self_component_port *self_port);
49
50 extern void *bt_self_component_port_get_data(
51 const bt_self_component_port *self_port);
52
53 #ifdef __cplusplus
54 }
55 #endif
56
57 #endif /* BABELTRACE2_GRAPH_SELF_COMPONENT_PORT_H */
This page took 0.030158 seconds and 4 git commands to generate.