lib: remove "For *" comments in public headers
[babeltrace.git] / include / babeltrace2 / graph / port-const.h
1 #ifndef BABELTRACE2_GRAPH_PORT_CONST_H
2 #define BABELTRACE2_GRAPH_PORT_CONST_H
3
4 /*
5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
6 * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@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/types.h>
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 typedef enum bt_port_type {
40 BT_PORT_TYPE_INPUT = 0,
41 BT_PORT_TYPE_OUTPUT = 1,
42 } bt_port_type;
43
44 extern const char *bt_port_get_name(const bt_port *port);
45
46 extern bt_port_type bt_port_get_type(const bt_port *port);
47
48 extern const bt_connection *bt_port_borrow_connection_const(
49 const bt_port *port);
50
51 extern const bt_component *bt_port_borrow_component_const(
52 const bt_port *port);
53
54 extern bt_bool bt_port_is_connected(const bt_port *port);
55
56 static inline
57 bt_bool bt_port_is_input(const bt_port *port)
58 {
59 return bt_port_get_type(port) == BT_PORT_TYPE_INPUT;
60 }
61
62 static inline
63 bt_bool bt_port_is_output(const bt_port *port)
64 {
65 return bt_port_get_type(port) == BT_PORT_TYPE_OUTPUT;
66 }
67
68 extern void bt_port_get_ref(const bt_port *port);
69
70 extern void bt_port_put_ref(const bt_port *port);
71
72 #define BT_PORT_PUT_REF_AND_RESET(_var) \
73 do { \
74 bt_port_put_ref(_var); \
75 (_var) = NULL; \
76 } while (0)
77
78 #define BT_PORT_MOVE_REF(_var_dst, _var_src) \
79 do { \
80 bt_port_put_ref(_var_dst); \
81 (_var_dst) = (_var_src); \
82 (_var_src) = NULL; \
83 } while (0)
84
85 #ifdef __cplusplus
86 }
87 #endif
88
89 #endif /* BABELTRACE2_GRAPH_PORT_CONST_H */
This page took 0.033164 seconds and 4 git commands to generate.