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

#ifndef BABELTRACE_COMPONENT_CONNECTION_INTERNAL_H
#define BABELTRACE_COMPONENT_CONNECTION_INTERNAL_H

/*
 * BabelTrace - Component Connection Internal
 *
 * 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.h>
#include <babeltrace/graph/private-connection.h>
#include <babeltrace/object-internal.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;
};

static inline
struct bt_connection *bt_connection_from_private(
		struct bt_private_connection *private_connection)
{
	return (void *) private_connection;
}

static inline
struct bt_private_connection *bt_private_connection_from_connection(
		struct bt_connection *connection)
{
	return (void *) connection;
}

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_disconnect_ports(struct bt_connection *conn);

#endif /* BABELTRACE_COMPONENT_CONNECTION_INTERNAL_H */
Commit	Line	Data
784cdc68 JG	1	#ifndef BABELTRACE_COMPONENT_CONNECTION_INTERNAL_H
	2	#define BABELTRACE_COMPONENT_CONNECTION_INTERNAL_H
	3
	4	/*
	5	* BabelTrace - Component Connection Internal
	6	*
	7	* Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	8	*
	9	* Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
	10	*
	11	* Permission is hereby granted, free of charge, to any person obtaining a copy
	12	* of this software and associated documentation files (the "Software"), to deal
	13	* in the Software without restriction, including without limitation the rights
	14	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	15	* copies of the Software, and to permit persons to whom the Software is
	16	* furnished to do so, subject to the following conditions:
	17	*
	18	* The above copyright notice and this permission notice shall be included in
	19	* all copies or substantial portions of the Software.
	20	*
	21	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	22	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	23	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	24	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	25	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	26	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	27	* SOFTWARE.
	28	*/
	29
b2e0c907 PP	30	#include <babeltrace/graph/connection.h>
b2e0c907 PP	31	#include <babeltrace/graph/private-connection.h>
784cdc68 JG	32	#include <babeltrace/object-internal.h>
	33
	34	struct bt_graph;
	35
	36	struct 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;
784cdc68 JG	51	};
784cdc68 JG	52
890882ef PP	53	static inline
	54	struct bt_connection *bt_connection_from_private(
	55	struct bt_private_connection *private_connection)
	56	{
	57	return (void *) private_connection;
	58	}
	59
	60	static inline
	61	struct bt_private_connection *bt_private_connection_from_connection(
	62	struct bt_connection *connection)
	63	{
	64	return (void *) connection;
	65	}
	66
784cdc68 JG	67	BT_HIDDEN
784cdc68 JG	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
2038affb	73	void bt_connection_disconnect_ports(struct bt_connection *conn);
784cdc68 JG	74
784cdc68 JG	75	#endif /* BABELTRACE_COMPONENT_CONNECTION_INTERNAL_H */