include/babeltrace/graph/connection-internal.h

   1 #ifndef BABELTRACE_GRAPH_CONNECTION_INTERNAL_H
   2 #define BABELTRACE_GRAPH_CONNECTION_INTERNAL_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 <babeltrace/graph/connection-const.h>
  29 #include <babeltrace/graph/notification-iterator.h>
  30 #include <babeltrace/graph/notification-iterator-internal.h>
  31 #include <babeltrace/object-internal.h>
  32 #include <babeltrace/assert-internal.h>
  33 #include <stdbool.h>
  34
  35 struct bt_graph;
  36
  37 struct bt_connection {
  38         /*
  39          * The graph is a connection's parent and the connection is the parent
  40          * of all iterators it has created.
  41          */
  42         struct bt_object base;
  43         /*
  44          * Weak references are held to both ports. Their existence is guaranteed
  45          * by the existence of the graph and thus, of their respective
  46          * components.
  47          */
  48         /* Downstream port. */
  49         struct bt_port *downstream_port;
  50         /* Upstream port. */
  51         struct bt_port *upstream_port;
  52
  53         /*
  54          * Weak references to all the notification iterators that were
  55          * created on this connection.
  56          */
  57         GPtrArray *iterators;
  58
  59         bool notified_upstream_port_connected;
  60         bool notified_upstream_port_disconnected;
  61         bool notified_downstream_port_connected;
  62         bool notified_downstream_port_disconnected;
  63         bool notified_graph_ports_connected;
  64         bool notified_graph_ports_disconnected;
  65 };
  66
  67 BT_HIDDEN
  68 struct bt_connection *bt_connection_create(struct bt_graph *graph,
  69                 struct bt_port *upstream_port,
  70                 struct bt_port *downstream_port);
  71
  72 BT_HIDDEN
  73 void bt_connection_end(struct bt_connection *conn, bool try_remove_from_graph);
  74
  75 BT_HIDDEN
  76 void bt_connection_remove_iterator(struct bt_connection *conn,
  77                 struct bt_self_component_port_input_notification_iterator *iterator);
  78
  79 static inline
  80 struct bt_graph *bt_connection_borrow_graph(struct bt_connection *conn)
  81 {
  82         BT_ASSERT(conn);
  83         return (void *) conn->base.parent;
  84 }
  85
  86 #endif /* BABELTRACE_GRAPH_CONNECTION_INTERNAL_H */