include/babeltrace/graph/port.h

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