[babeltrace.git] / include / babeltrace / graph / component.h

#ifndef BABELTRACE_GRAPH_COMPONENT_H
#define BABELTRACE_GRAPH_COMPONENT_H

/*
 * BabelTrace - Babeltrace Component Interface
 *
 * Copyright 2015 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/component-status.h>
#include <babeltrace/graph/component-class.h>
#include <babeltrace/graph/notification-iterator.h>
#include <babeltrace/values.h>
#include <stdbool.h>

#ifdef __cplusplus
extern "C" {
#endif

struct bt_component_class;
struct bt_component_graph;
struct bt_component;
struct bt_value;
struct bt_port;

/**
 * Create an instance of a component from a component class.
 *
 * @param component_class	Component class of which to create an instance
 * @param name			Name of the new component instance, optional
 * @param params		A dictionary of component parameters
 * @returns			Returns a pointer to a new component instance
 */
extern struct bt_component *bt_component_create(
		struct bt_component_class *component_class, const char *name,
		struct bt_value *params);

extern struct bt_component *bt_component_create_with_init_method_data(
		struct bt_component_class *component_class, const char *name,
		struct bt_value *params, void *init_method_data);

/**
 * Get component's name.
 *
 * @param component	Component instance of which to get the name
 * @returns		Returns a pointer to the component's name
 */
extern const char *bt_component_get_name(struct bt_component *component);

/**
 * Get component's class.
 *
 * @param component	Component instance of which to get the class
 * @returns		The component's class
 */
extern struct bt_component_class *bt_component_get_class(
		struct bt_component *component);

extern enum bt_component_class_type bt_component_get_class_type(
		struct bt_component *component);

static inline
bool bt_component_is_source(struct bt_component *component)
{
	return bt_component_get_class_type(component) ==
		BT_COMPONENT_CLASS_TYPE_SOURCE;
}

static inline
bool bt_component_is_filter(struct bt_component *component)
{
	return bt_component_get_class_type(component) ==
		BT_COMPONENT_CLASS_TYPE_FILTER;
}

static inline
bool bt_component_is_sink(struct bt_component *component)
{
	return bt_component_get_class_type(component) ==
		BT_COMPONENT_CLASS_TYPE_SINK;
}

extern struct bt_graph *bt_component_get_graph(struct bt_component *component);

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_GRAPH_COMPONENT_H */
Commit	Line	Data
	1	#ifndef BABELTRACE_GRAPH_COMPONENT_H
	2	#define BABELTRACE_GRAPH_COMPONENT_H
	3
	4	/*
	5	* BabelTrace - Babeltrace Component Interface
	6	*
	7	* Copyright 2015 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
	30	#include <babeltrace/graph/component-status.h>
	31	#include <babeltrace/graph/component-class.h>
	32	#include <babeltrace/graph/notification-iterator.h>
	33	#include <babeltrace/values.h>
	34	#include <stdbool.h>
	35
	36	#ifdef __cplusplus
	37	extern "C" {
	38	#endif
	39
	40	struct bt_component_class;
	41	struct bt_component_graph;
	42	struct bt_component;
	43	struct bt_value;
	44	struct bt_port;
	45
	46	/**
	47	* Create an instance of a component from a component class.
	48	*
	49	* @param component_class Component class of which to create an instance
	50	* @param name Name of the new component instance, optional
	51	* @param params A dictionary of component parameters
	52	* @returns Returns a pointer to a new component instance
	53	*/
	54	extern struct bt_component *bt_component_create(
	55	struct bt_component_class component_class, const char name,
	56	struct bt_value *params);
	57
	58	extern struct bt_component *bt_component_create_with_init_method_data(
	59	struct bt_component_class component_class, const char name,
	60	struct bt_value params, void init_method_data);
	61
	62	/**
	63	* Get component's name.
	64	*
	65	* @param component Component instance of which to get the name
	66	* @returns Returns a pointer to the component's name
	67	*/
	68	extern const char bt_component_get_name(struct bt_component component);
	69
	70	/**
	71	* Get component's class.
	72	*
	73	* @param component Component instance of which to get the class
	74	* @returns The component's class
	75	*/
	76	extern struct bt_component_class *bt_component_get_class(
	77	struct bt_component *component);
	78
	79	extern enum bt_component_class_type bt_component_get_class_type(
	80	struct bt_component *component);
	81
	82	static inline
	83	bool bt_component_is_source(struct bt_component *component)
	84	{
	85	return bt_component_get_class_type(component) ==
	86	BT_COMPONENT_CLASS_TYPE_SOURCE;
	87	}
	88
	89	static inline
	90	bool bt_component_is_filter(struct bt_component *component)
	91	{
	92	return bt_component_get_class_type(component) ==
	93	BT_COMPONENT_CLASS_TYPE_FILTER;
	94	}
	95
	96	static inline
	97	bool bt_component_is_sink(struct bt_component *component)
	98	{
	99	return bt_component_get_class_type(component) ==
	100	BT_COMPONENT_CLASS_TYPE_SINK;
	101	}
	102
	103	extern struct bt_graph bt_component_get_graph(struct bt_component component);
	104
	105	#ifdef __cplusplus
	106	}
	107	#endif
	108
	109	#endif /* BABELTRACE_GRAPH_COMPONENT_H */