include/babeltrace/graph/self-component-port.h

   1 #ifndef BABELTRACE_GRAPH_SELF_COMPONENT_PORT_H
   2 #define BABELTRACE_GRAPH_SELF_COMPONENT_PORT_H
   3
   4 /*
   5  * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  */
  25
  26 #ifdef __cplusplus
  27 extern "C" {
  28 #endif
  29
  30 struct bt_port;
  31 struct bt_self_component_port;
  32 struct bt_self_component;
  33 struct bt_connection;
  34
  35 enum bt_self_component_port_status {
  36         BT_SELF_PORT_STATUS_OK = 0,
  37         BT_SELF_PORT_STATUS_ERROR = -1,
  38 };
  39
  40 static inline
  41 struct bt_port *bt_self_component_port_borrow_port(
  42                 struct bt_self_component_port *self_port)
  43 {
  44         return (void *) self_port;
  45 }
  46
  47 extern struct bt_self_component *bt_self_component_port_borrow_component(
  48                 struct bt_self_component_port *self_port);
  49
  50 extern enum bt_self_component_port_status
  51 bt_self_component_port_remove_from_component(
  52                 struct bt_self_component_port *self_port);
  53
  54 extern void *bt_self_component_port_get_data(
  55                 struct bt_self_component_port *self_port);
  56
  57 #ifdef __cplusplus
  58 }
  59 #endif
  60
  61 #endif /* BABELTRACE_GRAPH_SELF_COMPONENT_PORT_H */