include/babeltrace/graph/port-internal.h

   1 #ifndef BABELTRACE_GRAPH_PORT_INTERNAL_H
   2 #define BABELTRACE_GRAPH_PORT_INTERNAL_H
   3
   4 /*
   5  * BabelTrace - Babeltrace Component Port
   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 <babeltrace/graph/port.h>
  31
  32 struct bt_port {
  33         struct bt_object base;
  34         enum bt_port_type type;
  35         GString *name;
  36         struct bt_connection *connection;
  37         void *user_data;
  38 };
  39
  40 static inline
  41 struct bt_private_port *bt_private_port_from_port(
  42                 struct bt_port *port)
  43 {
  44         return (void *) port;
  45 }
  46
  47 BT_HIDDEN
  48 struct bt_port *bt_port_create(struct bt_component *parent_component,
  49                 enum bt_port_type type, const char *name, void *user_data);
  50
  51 BT_HIDDEN
  52 void bt_port_set_connection(struct bt_port *port,
  53                 struct bt_connection *connection);
  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         case BT_PORT_TYPE_UNKOWN:
  64                 return "BT_PORT_TYPE_UNKOWN";
  65         default:
  66                 return "(unknown)";
  67         }
  68 }
  69
  70 #endif /* BABELTRACE_GRAPH_PORT_INTERNAL_H */