Cleanup: remove private babeltrace.h
[babeltrace.git] / src / lib / graph / connection.h
CommitLineData
abe30a8f
PP
1#ifndef BABELTRACE_GRAPH_CONNECTION_INTERNAL_H
2#define BABELTRACE_GRAPH_CONNECTION_INTERNAL_H
784cdc68
JG
3
4/*
f2b0325d 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
71c5da58
MJ
27#include <babeltrace2/graph/connection-const.h>
28#include <babeltrace2/graph/message-iterator-const.h>
57952005
MJ
29#include "lib/object.h"
30#include "common/assert.h"
85e7137b 31#include "common/macros.h"
c42ea0af 32#include <stdbool.h>
784cdc68 33
57952005
MJ
34#include "message/iterator.h"
35
784cdc68
JG
36struct bt_graph;
37
38struct bt_connection {
39 /*
40 * The graph is a connection's parent and the connection is the parent
41 * of all iterators it has created.
42 */
43 struct bt_object base;
44 /*
45 * Weak references are held to both ports. Their existence is guaranteed
46 * by the existence of the graph and thus, of their respective
47 * components.
48 */
49 /* Downstream port. */
72b913fb 50 struct bt_port *downstream_port;
784cdc68 51 /* Upstream port. */
72b913fb 52 struct bt_port *upstream_port;
bd14d768
PP
53
54 /*
b09a5592 55 * Weak references to all the message iterators that were
bd14d768
PP
56 * created on this connection.
57 */
58 GPtrArray *iterators;
634f394c 59
0f15970b 60 bool notified_upstream_port_connected;
0f15970b 61 bool notified_downstream_port_connected;
0f15970b 62 bool notified_graph_ports_connected;
784cdc68
JG
63};
64
65BT_HIDDEN
66struct bt_connection *bt_connection_create(struct bt_graph *graph,
72b913fb
PP
67 struct bt_port *upstream_port,
68 struct bt_port *downstream_port);
69
70BT_HIDDEN
c42ea0af 71void bt_connection_end(struct bt_connection *conn, bool try_remove_from_graph);
784cdc68 72
bd14d768
PP
73BT_HIDDEN
74void bt_connection_remove_iterator(struct bt_connection *conn,
b09a5592 75 struct bt_self_component_port_input_message_iterator *iterator);
bd14d768 76
c28d097c
PP
77static inline
78struct bt_graph *bt_connection_borrow_graph(struct bt_connection *conn)
79{
8b45963b 80 BT_ASSERT(conn);
c28d097c
PP
81 return (void *) conn->base.parent;
82}
83
abe30a8f 84#endif /* BABELTRACE_GRAPH_CONNECTION_INTERNAL_H */
This page took 0.054828 seconds and 4 git commands to generate.