include/babeltrace/graph/port-const.h

   1 #ifndef BABELTRACE_GRAPH_PORT_CONST_H
   2 #define BABELTRACE_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 #include <stdint.h>
  28
  29 /* For bt_bool */
  30 #include <babeltrace/types.h>
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 struct bt_port;
  37 struct bt_connection;
  38 struct bt_component;
  39
  40 enum bt_port_type {
  41         BT_PORT_TYPE_INPUT = 0,
  42         BT_PORT_TYPE_OUTPUT = 1,
  43 };
  44
  45 extern const char *bt_port_get_name(const struct bt_port *port);
  46
  47 extern enum bt_port_type bt_port_get_type(const struct bt_port *port);
  48
  49 extern const struct bt_connection *bt_port_borrow_connection_const(
  50                 const struct bt_port *port);
  51
  52 extern const struct bt_component *bt_port_borrow_component_const(
  53                 const struct bt_port *port);
  54
  55 extern bt_bool bt_port_is_connected(const struct bt_port *port);
  56
  57 static inline
  58 bt_bool bt_port_is_input(const struct bt_port *port)
  59 {
  60         return bt_port_get_type(port) == BT_PORT_TYPE_INPUT;
  61 }
  62
  63 static inline
  64 bt_bool bt_port_is_output(const struct bt_port *port)
  65 {
  66         return bt_port_get_type(port) == BT_PORT_TYPE_OUTPUT;
  67 }
  68
  69 #ifdef __cplusplus
  70 }
  71 #endif
  72
  73 #endif /* BABELTRACE_GRAPH_PORT_CONST_H */