projects / babeltrace.git / blame
| Commit | Line | Data |
|---|---|---|
| 1ca80abd PP |
1 | #ifndef BABELTRACE_GRAPH_PORT_H |
| 2 | #define BABELTRACE_GRAPH_PORT_H | |
| 8b285017 JG |
3 | |
| 4 | /* | |
| 5 | * BabelTrace - Babeltrace Component Connection Interface | |
| 6 | * | |
| 7 | * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
| 8 | * | |
| 9 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
| 10 | * | |
| 11 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
| 12 | * of this software and associated documentation files (the "Software"), to deal | |
| 13 | * in the Software without restriction, including without limitation the rights | |
| 14 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
| 15 | * copies of the Software, and to permit persons to whom the Software is | |
| 16 | * furnished to do so, subject to the following conditions: | |
| 17 | * | |
| 18 | * The above copyright notice and this permission notice shall be included in | |
| 19 | * all copies or substantial portions of the Software. | |
| 20 | * | |
| 21 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
| 22 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
| 23 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
| 24 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
| 25 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
| 26 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
| 27 | * SOFTWARE. | |
| 28 | */ | |
| 29 | ||
| 30 | #include <stdint.h> | |
| 9d408fca PP |
31 | |
| 32 | /* For bt_bool */ | |
| c55a9f58 | 33 | #include <babeltrace/types.h> |
| 8b285017 JG |
34 | |
| 35 | #ifdef __cplusplus | |
| 36 | extern "C" { | |
| 37 | #endif | |
| 38 | ||
| 39 | struct bt_port; | |
| 40 | struct bt_connection; | |
| 41 | ||
| 42 | enum bt_port_status { | |
| 43 | BT_PORT_STATUS_OK = 0, | |
| 44 | BT_PORT_STATUS_ERROR = -1, | |
| 45 | BT_PORT_STATUS_INVALID = -2, | |
| 46 | }; | |
| 47 | ||
| 48 | enum bt_port_type { | |
| 49 | BT_PORT_TYPE_INPUT = 0, | |
| 50 | BT_PORT_TYPE_OUTPUT = 1, | |
| 51 | BT_PORT_TYPE_UNKOWN = -1, | |
| 52 | }; | |
| 53 | ||
| 8b285017 JG |
54 | extern const char *bt_port_get_name(struct bt_port *port); |
| 55 | extern enum bt_port_type bt_port_get_type(struct bt_port *port); | |
| 72b913fb | 56 | extern struct bt_connection *bt_port_get_connection(struct bt_port *port); |
| 8b285017 | 57 | extern struct bt_component *bt_port_get_component(struct bt_port *port); |
| 7d62a2ab | 58 | extern enum bt_port_status bt_port_disconnect(struct bt_port *port); |
| b65cfd0f | 59 | extern bt_bool bt_port_is_connected(struct bt_port *port); |
| 8b285017 | 60 | |
| e3655084 | 61 | static inline |
| c55a9f58 | 62 | bt_bool bt_port_is_input(struct bt_port *port) |
| e3655084 PP |
63 | { |
| 64 | return bt_port_get_type(port) == BT_PORT_TYPE_INPUT; | |
| 65 | } | |
| 66 | ||
| 67 | static inline | |
| c55a9f58 | 68 | bt_bool bt_port_is_output(struct bt_port *port) |
| e3655084 PP |
69 | { |
| 70 | return bt_port_get_type(port) == BT_PORT_TYPE_OUTPUT; | |
| 71 | } | |
| 72 | ||
| 8b285017 JG |
73 | #ifdef __cplusplus |
| 74 | } | |
| 75 | #endif | |
| 76 | ||
| 1ca80abd | 77 | #endif /* BABELTRACE_GRAPH_PORT_H */ |