lib: graph.c: add missing `enum` and `const` keywords
[babeltrace.git] / src / lib / graph / connection.h
1 #ifndef BABELTRACE_GRAPH_CONNECTION_INTERNAL_H
2 #define BABELTRACE_GRAPH_CONNECTION_INTERNAL_H
3
4 /*
5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
6 * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 *
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
27 #include <babeltrace2/graph/connection-const.h>
28 #include "lib/object.h"
29 #include "common/assert.h"
30 #include "common/macros.h"
31 #include <stdbool.h>
32
33 #include "message/iterator.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 message iterators that were
55 * created on this connection.
56 */
57 GPtrArray *iterators;
58
59 bool notified_upstream_port_connected;
60 bool notified_downstream_port_connected;
61 bool notified_graph_ports_connected;
62 };
63
64 BT_HIDDEN
65 struct bt_connection *bt_connection_create(struct bt_graph *graph,
66 struct bt_port *upstream_port,
67 struct bt_port *downstream_port);
68
69 BT_HIDDEN
70 void bt_connection_end(struct bt_connection *conn, bool try_remove_from_graph);
71
72 BT_HIDDEN
73 void bt_connection_remove_iterator(struct bt_connection *conn,
74 struct bt_self_component_port_input_message_iterator *iterator);
75
76 static inline
77 struct bt_graph *bt_connection_borrow_graph(struct bt_connection *conn)
78 {
79 BT_ASSERT(conn);
80 return (void *) conn->base.parent;
81 }
82
83 #endif /* BABELTRACE_GRAPH_CONNECTION_INTERNAL_H */
This page took 0.030931 seconds and 4 git commands to generate.