lib: Add functions to borrow specialized component classes from specialized components
[babeltrace.git] / include / babeltrace / graph / connection-internal.h
CommitLineData
6ac74c0c
PP
1#ifndef BABELTRACE_GRAPH_CONNECTION_INTERNAL_H
2#define BABELTRACE_GRAPH_CONNECTION_INTERNAL_H
784cdc68
JG
3
4/*
e2f7325d 5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
784cdc68
JG
6 * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 *
784cdc68
JG
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
0d72b8c3 27#include <babeltrace/graph/connection-const.h>
7474e7d3 28#include <babeltrace/graph/message-iterator-const.h>
d6e69534 29#include <babeltrace/graph/message-iterator-internal.h>
784cdc68 30#include <babeltrace/object-internal.h>
f6ccaed9 31#include <babeltrace/assert-internal.h>
c42ea0af 32#include <stdbool.h>
784cdc68
JG
33
34struct bt_graph;
35
36struct bt_connection {
37 /*
38 * The graph is a connection's parent and the connection is the parent
39 * of all iterators it has created.
40 */
41 struct bt_object base;
42 /*
43 * Weak references are held to both ports. Their existence is guaranteed
44 * by the existence of the graph and thus, of their respective
45 * components.
46 */
47 /* Downstream port. */
72b913fb 48 struct bt_port *downstream_port;
784cdc68 49 /* Upstream port. */
72b913fb 50 struct bt_port *upstream_port;
bd14d768
PP
51
52 /*
d6e69534 53 * Weak references to all the message iterators that were
bd14d768
PP
54 * created on this connection.
55 */
56 GPtrArray *iterators;
bf55043c 57
85031ceb 58 bool notified_upstream_port_connected;
85031ceb 59 bool notified_downstream_port_connected;
85031ceb 60 bool notified_graph_ports_connected;
784cdc68
JG
61};
62
63BT_HIDDEN
64struct bt_connection *bt_connection_create(struct bt_graph *graph,
72b913fb
PP
65 struct bt_port *upstream_port,
66 struct bt_port *downstream_port);
67
68BT_HIDDEN
c42ea0af 69void bt_connection_end(struct bt_connection *conn, bool try_remove_from_graph);
784cdc68 70
bd14d768
PP
71BT_HIDDEN
72void bt_connection_remove_iterator(struct bt_connection *conn,
d6e69534 73 struct bt_self_component_port_input_message_iterator *iterator);
bd14d768 74
c28d097c
PP
75static inline
76struct bt_graph *bt_connection_borrow_graph(struct bt_connection *conn)
77{
f6ccaed9 78 BT_ASSERT(conn);
c28d097c
PP
79 return (void *) conn->base.parent;
80}
81
6ac74c0c 82#endif /* BABELTRACE_GRAPH_CONNECTION_INTERNAL_H */
This page took 0.041945 seconds and 4 git commands to generate.