[babeltrace.git] / include / babeltrace / graph / connection-internal.h

#ifndef BABELTRACE_GRAPH_CONNECTION_INTERNAL_H
#define BABELTRACE_GRAPH_CONNECTION_INTERNAL_H

/*
 * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#include <babeltrace/graph/connection-const.h>
#include <babeltrace/graph/notification-iterator.h>
#include <babeltrace/graph/notification-iterator-internal.h>
#include <babeltrace/object-internal.h>
#include <babeltrace/assert-internal.h>
#include <stdbool.h>

struct bt_graph;

struct bt_connection {
	/*
	 * The graph is a connection's parent and the connection is the parent
	 * of all iterators it has created.
	 */
	struct bt_object base;
	/*
	 * Weak references are held to both ports. Their existence is guaranteed
	 * by the existence of the graph and thus, of their respective
	 * components.
	 */
	/* Downstream port. */
	struct bt_port *downstream_port;
	/* Upstream port. */
	struct bt_port *upstream_port;

	/*
	 * Weak references to all the notification iterators that were
	 * created on this connection.
	 */
	GPtrArray *iterators;

	bool notified_upstream_port_connected;
	bool notified_upstream_port_disconnected;
	bool notified_downstream_port_connected;
	bool notified_downstream_port_disconnected;
	bool notified_graph_ports_connected;
	bool notified_graph_ports_disconnected;
};

BT_HIDDEN
struct bt_connection *bt_connection_create(struct bt_graph *graph,
		struct bt_port *upstream_port,
		struct bt_port *downstream_port);

BT_HIDDEN
void bt_connection_end(struct bt_connection *conn, bool try_remove_from_graph);

BT_HIDDEN
void bt_connection_remove_iterator(struct bt_connection *conn,
		struct bt_self_component_port_input_notification_iterator *iterator);

static inline
struct bt_graph *bt_connection_borrow_graph(struct bt_connection *conn)
{
	BT_ASSERT(conn);
	return (void *) conn->base.parent;
}

#endif /* BABELTRACE_GRAPH_CONNECTION_INTERNAL_H */
Commit	Line	Data
6ac74c0c PP	1	#ifndef BABELTRACE_GRAPH_CONNECTION_INTERNAL_H
6ac74c0c PP	2	#define BABELTRACE_GRAPH_CONNECTION_INTERNAL_H
784cdc68 JG	3
784cdc68 JG	4	/*
784cdc68 JG	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
0d72b8c3	28	#include <babeltrace/graph/connection-const.h>
73d5c1ad	29	#include <babeltrace/graph/notification-iterator.h>
90157d89	30	#include <babeltrace/graph/notification-iterator-internal.h>
784cdc68	31	#include <babeltrace/object-internal.h>
f6ccaed9	32	#include <babeltrace/assert-internal.h>
c42ea0af	33	#include <stdbool.h>
784cdc68 JG	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. */
72b913fb	49	struct bt_port *downstream_port;
784cdc68	50	/* Upstream port. */
72b913fb	51	struct bt_port *upstream_port;
bd14d768 PP	52
	53	/*
	54	* Weak references to all the notification iterators that were
	55	* created on this connection.
	56	*/
	57	GPtrArray *iterators;
bf55043c PP	58
bf55043c PP	59	bool notified_upstream_port_connected;
d94d92ac	60	bool notified_upstream_port_disconnected;
bf55043c	61	bool notified_downstream_port_connected;
d94d92ac	62	bool notified_downstream_port_disconnected;
bf55043c	63	bool notified_graph_ports_connected;
d94d92ac	64	bool notified_graph_ports_disconnected;
784cdc68 JG	65	};
	66
	67	BT_HIDDEN
	68	struct bt_connection bt_connection_create(struct bt_graph graph,
72b913fb PP	69	struct bt_port *upstream_port,
	70	struct bt_port *downstream_port);
	71
	72	BT_HIDDEN
c42ea0af	73	void bt_connection_end(struct bt_connection *conn, bool try_remove_from_graph);
784cdc68	74
bd14d768 PP	75	BT_HIDDEN
bd14d768 PP	76	void bt_connection_remove_iterator(struct bt_connection *conn,
d94d92ac	77	struct bt_self_component_port_input_notification_iterator *iterator);
bd14d768	78
c28d097c PP	79	static inline
	80	struct bt_graph bt_connection_borrow_graph(struct bt_connection conn)
	81	{
f6ccaed9	82	BT_ASSERT(conn);
c28d097c PP	83	return (void *) conn->base.parent;
	84	}
	85
6ac74c0c	86	#endif /* BABELTRACE_GRAPH_CONNECTION_INTERNAL_H */