src/lib/graph/port.h

   1 #ifndef BABELTRACE_GRAPH_PORT_INTERNAL_H
   2 #define BABELTRACE_GRAPH_PORT_INTERNAL_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 <babeltrace2/graph/port-const.h>
  28 #include "common/macros.h"
  29
  30 struct bt_port {
  31         struct bt_object base;
  32         enum bt_port_type type;
  33         GString *name;
  34         struct bt_connection *connection;
  35         void *user_data;
  36 };
  37
  38 struct bt_component;
  39
  40 BT_HIDDEN
  41 struct bt_port *bt_port_create(struct bt_component *parent_component,
  42                 enum bt_port_type type, const char *name, void *user_data);
  43
  44 BT_HIDDEN
  45 void bt_port_set_connection(struct bt_port *port,
  46                 struct bt_connection *connection);
  47
  48 static inline
  49 struct bt_component *bt_port_borrow_component_inline(const struct bt_port *port)
  50 {
  51         BT_ASSERT(port);
  52         return (void *) bt_object_borrow_parent(&port->base);
  53 }
  54
  55 static inline
  56 const char *bt_port_type_string(enum bt_port_type port_type)
  57 {
  58         switch (port_type) {
  59         case BT_PORT_TYPE_INPUT:
  60                 return "BT_PORT_TYPE_INPUT";
  61         case BT_PORT_TYPE_OUTPUT:
  62                 return "BT_PORT_TYPE_OUTPUT";
  63         default:
  64                 return "(unknown)";
  65         }
  66 }
  67
  68 #endif /* BABELTRACE_GRAPH_PORT_INTERNAL_H */