projects / babeltrace.git / blame
| Commit | Line | Data |
|---|---|---|
| 924dc299 PP |
1 | #ifndef BABELTRACE2_GRAPH_PORT_CONST_H |
| 2 | #define BABELTRACE2_GRAPH_PORT_CONST_H | |
| 8b285017 JG |
3 | |
| 4 | /* | |
| e2f7325d | 5 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
| 8b285017 JG |
6 | * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
| 7 | * | |
| 8b285017 JG |
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 | ||
| 4fa90f32 PP |
27 | #ifndef __BT_IN_BABELTRACE_H |
| 28 | # error "Please include <babeltrace2/babeltrace.h> instead." | |
| 29 | #endif | |
| 30 | ||
| 8b285017 | 31 | #include <stdint.h> |
| 9d408fca | 32 | |
| b19ff26f | 33 | /* For bt_bool, bt_port, bt_connection, bt_component */ |
| 3fadfbc0 | 34 | #include <babeltrace2/types.h> |
| 8b285017 JG |
35 | |
| 36 | #ifdef __cplusplus | |
| 37 | extern "C" { | |
| 38 | #endif | |
| 39 | ||
| 4cdfc5e8 | 40 | typedef enum bt_port_type { |
| 8b285017 JG |
41 | BT_PORT_TYPE_INPUT = 0, |
| 42 | BT_PORT_TYPE_OUTPUT = 1, | |
| 4cdfc5e8 | 43 | } bt_port_type; |
| 8b285017 | 44 | |
| b19ff26f | 45 | extern const char *bt_port_get_name(const bt_port *port); |
| d94d92ac | 46 | |
| 4cdfc5e8 | 47 | extern bt_port_type bt_port_get_type(const bt_port *port); |
| d94d92ac | 48 | |
| b19ff26f PP |
49 | extern const bt_connection *bt_port_borrow_connection_const( |
| 50 | const bt_port *port); | |
| d94d92ac | 51 | |
| b19ff26f PP |
52 | extern const bt_component *bt_port_borrow_component_const( |
| 53 | const bt_port *port); | |
| d94d92ac | 54 | |
| b19ff26f | 55 | extern bt_bool bt_port_is_connected(const bt_port *port); |
| 8b285017 | 56 | |
| e3655084 | 57 | static inline |
| b19ff26f | 58 | bt_bool bt_port_is_input(const bt_port *port) |
| e3655084 PP |
59 | { |
| 60 | return bt_port_get_type(port) == BT_PORT_TYPE_INPUT; | |
| 61 | } | |
| 62 | ||
| 63 | static inline | |
| b19ff26f | 64 | bt_bool bt_port_is_output(const bt_port *port) |
| e3655084 PP |
65 | { |
| 66 | return bt_port_get_type(port) == BT_PORT_TYPE_OUTPUT; | |
| 67 | } | |
| 68 | ||
| b19ff26f | 69 | extern void bt_port_get_ref(const bt_port *port); |
| c5b9b441 | 70 | |
| b19ff26f | 71 | extern void bt_port_put_ref(const bt_port *port); |
| c5b9b441 PP |
72 | |
| 73 | #define BT_PORT_PUT_REF_AND_RESET(_var) \ | |
| 74 | do { \ | |
| 75 | bt_port_put_ref(_var); \ | |
| 76 | (_var) = NULL; \ | |
| 77 | } while (0) | |
| 78 | ||
| 79 | #define BT_PORT_MOVE_REF(_var_dst, _var_src) \ | |
| 80 | do { \ | |
| 81 | bt_port_put_ref(_var_dst); \ | |
| 82 | (_var_dst) = (_var_src); \ | |
| 83 | (_var_src) = NULL; \ | |
| 84 | } while (0) | |
| 85 | ||
| 8b285017 JG |
86 | #ifdef __cplusplus |
| 87 | } | |
| 88 | #endif | |
| 89 | ||
| 924dc299 | 90 | #endif /* BABELTRACE2_GRAPH_PORT_CONST_H */ |