[babeltrace.git] / src / lib / graph / port.h

#ifndef BABELTRACE_GRAPH_PORT_INTERNAL_H
#define BABELTRACE_GRAPH_PORT_INTERNAL_H

/*
 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
 * Copyright 2017 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 <babeltrace2/graph/port-const.h>
#include "common/macros.h"

struct bt_port {
	struct bt_object base;
	enum bt_port_type type;
	GString *name;
	struct bt_connection *connection;
	void *user_data;
};

struct bt_component;

BT_HIDDEN
struct bt_port *bt_port_create(struct bt_component *parent_component,
		enum bt_port_type type, const char *name, void *user_data);

BT_HIDDEN
void bt_port_set_connection(struct bt_port *port,
		struct bt_connection *connection);

static inline
struct bt_component *bt_port_borrow_component_inline(const struct bt_port *port)
{
	BT_ASSERT(port);
	return (void *) bt_object_borrow_parent(&port->base);
}

static inline
const char *bt_port_type_string(enum bt_port_type port_type)
{
	switch (port_type) {
	case BT_PORT_TYPE_INPUT:
		return "BT_PORT_TYPE_INPUT";
	case BT_PORT_TYPE_OUTPUT:
		return "BT_PORT_TYPE_OUTPUT";
	default:
		return "(unknown)";
	}
}

#endif /* BABELTRACE_GRAPH_PORT_INTERNAL_H */
Commit	Line	Data
6ac74c0c PP	1	#ifndef BABELTRACE_GRAPH_PORT_INTERNAL_H
6ac74c0c PP	2	#define BABELTRACE_GRAPH_PORT_INTERNAL_H
8b285017 JG	3
8b285017 JG	4	/*
e2f7325d	5	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
8b285017	6	* Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8b285017 JG	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
3fadfbc0	27	#include <babeltrace2/graph/port-const.h>
91d81473	28	#include "common/macros.h"
8b285017	29
8b285017 JG	30	struct bt_port {
	31	struct bt_object base;
	32	enum bt_port_type type;
	33	GString *name;
72b913fb	34	struct bt_connection *connection;
a45a0b60	35	void *user_data;
8b285017 JG	36	};
8b285017 JG	37
0d72b8c3 PP	38	struct bt_component;
0d72b8c3 PP	39
8b285017 JG	40	BT_HIDDEN
8b285017 JG	41	struct bt_port bt_port_create(struct bt_component parent_component,
3e9b0023	42	enum bt_port_type type, const char name, void user_data);
8b285017 JG	43
8b285017 JG	44	BT_HIDDEN
72b913fb	45	void bt_port_set_connection(struct bt_port *port,
8b285017 JG	46	struct bt_connection *connection);
8b285017 JG	47
0d72b8c3 PP	48	static inline
	49	struct bt_component bt_port_borrow_component_inline(const struct bt_port port)
	50	{
	51	BT_ASSERT(port);
	52	return (void *) bt_object_borrow_parent(&port->base);
	53	}
	54
ab0d387b PP	55	static inline
	56	const char *bt_port_type_string(enum bt_port_type port_type)
	57	{
	58	switch (port_type) {
	59	case BT_PORT_TYPE_INPUT:
	60	return "BT_PORT_TYPE_INPUT";
	61	case BT_PORT_TYPE_OUTPUT:
	62	return "BT_PORT_TYPE_OUTPUT";
ab0d387b PP	63	default:
	64	return "(unknown)";
	65	}
8b285017	66	}
8b285017	67
6ac74c0c	68	#endif /* BABELTRACE_GRAPH_PORT_INTERNAL_H */