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

#ifndef BABELTRACE_COMPONENT_COMPONENT_H
#define BABELTRACE_COMPONENT_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/component/component-class.h>
#include <babeltrace/component/notification/iterator.h>
#include <babeltrace/values.h>
#include <stdio.h>

#ifdef __cplusplus
extern "C" {
#endif

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

/**
 * Status code. Errors are always negative.
 */
enum bt_component_status {
	/** No error, okay. */
	BT_COMPONENT_STATUS_OK =		0,
	/** No more work to be done by this component. **/
	BT_COMPONENT_STATUS_END =		1,
	/**
	 * Component can't process a notification at this time
	 * (e.g. would block), try again later.
	 */
	BT_COMPONENT_STATUS_AGAIN =		2,
	/** General error. */
	BT_COMPONENT_STATUS_ERROR =		-1,
	/** Unsupported component feature. */
	BT_COMPONENT_STATUS_UNSUPPORTED =	-2,
	/** Invalid arguments. */
	BT_COMPONENT_STATUS_INVALID =		-3,
	/** Memory allocation failure. */
	BT_COMPONENT_STATUS_NOMEM =		-4,
	/** Element not found. */
	BT_COMPONENT_STATUS_NOT_FOUND =		-5,
};

/**
 * 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 a component's private data.
 *
 * @param component	Component of which to get the private data
 * @returns		Component's private data
 */
extern void *bt_component_get_private_data(struct bt_component *component);

/**
 * Set a component's private data.
 *
 * @param component	Component of which to set the private data
 * @param data		Component private data
 * @returns		One of #bt_component_status values
 */
extern enum bt_component_status bt_component_set_private_data(
		struct bt_component *component, void *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);

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

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_COMPONENT_COMPONENT_H */
Commit	Line	Data
33b34c43 PP	1	#ifndef BABELTRACE_COMPONENT_COMPONENT_H
33b34c43 PP	2	#define BABELTRACE_COMPONENT_COMPONENT_H
43de0e13 JG	3
43de0e13 JG	4	/*
33b34c43	5	* BabelTrace - Babeltrace Component Interface
43de0e13 JG	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
f60c8b34	30	#include <babeltrace/component/component-class.h>
33b34c43 PP	31	#include <babeltrace/component/notification/iterator.h>
	32	#include <babeltrace/values.h>
	33	#include <stdio.h>
30d619df	34
43de0e13 JG	35	#ifdef __cplusplus
	36	extern "C" {
	37	#endif
	38
f60c8b34 JG	39	struct bt_component_class;
	40	struct bt_component_graph;
	41	struct bt_component;
	42	struct bt_value;
	43
33b34c43 PP	44	/**
	45	* Status code. Errors are always negative.
	46	*/
	47	enum bt_component_status {
	48	/** No error, okay. */
	49	BT_COMPONENT_STATUS_OK = 0,
	50	/ No more work to be done by this component. /
	51	BT_COMPONENT_STATUS_END = 1,
	52	/**
	53	* Component can't process a notification at this time
	54	* (e.g. would block), try again later.
	55	*/
	56	BT_COMPONENT_STATUS_AGAIN = 2,
	57	/** General error. */
	58	BT_COMPONENT_STATUS_ERROR = -1,
	59	/** Unsupported component feature. */
	60	BT_COMPONENT_STATUS_UNSUPPORTED = -2,
	61	/** Invalid arguments. */
	62	BT_COMPONENT_STATUS_INVALID = -3,
	63	/** Memory allocation failure. */
	64	BT_COMPONENT_STATUS_NOMEM = -4,
f60c8b34 JG	65	/** Element not found. */
f60c8b34 JG	66	BT_COMPONENT_STATUS_NOT_FOUND = -5,
33b34c43 PP	67	};
33b34c43 PP	68
43de0e13	69	/**
d3e4dcd8	70	* Create an instance of a component from a component class.
2bd8a567	71	*
d3e4dcd8 PP	72	* @param component_class Component class of which to create an instance
	73	* @param name Name of the new component instance, optional
	74	* @param params A dictionary of component parameters
	75	* @returns Returns a pointer to a new component instance
2bd8a567	76	*/
d3e4dcd8 PP	77	extern struct bt_component *bt_component_create(
	78	struct bt_component_class component_class, const char name,
	79	struct bt_value *params);
33b34c43	80
6358c163 PP	81	extern struct bt_component *bt_component_create_with_init_method_data(
	82	struct bt_component_class component_class, const char name,
	83	struct bt_value params, void init_method_data);
	84
8738a040 JG	85	/**
	86	* Get a component's private data.
	87	*
	88	* @param component Component of which to get the private data
	89	* @returns Component's private data
	90	*/
	91	extern void bt_component_get_private_data(struct bt_component component);
47e5a032	92
8738a040 JG	93	/**
	94	* Set a component's private data.
	95	*
	96	* @param component Component of which to set the private data
	97	* @param data Component private data
	98	* @returns One of #bt_component_status values
	99	*/
	100	extern enum bt_component_status bt_component_set_private_data(
	101	struct bt_component component, void data);
	102
d97bac96	103	/**
33b34c43	104	* Get component's name.
d97bac96	105	*
33b34c43 PP	106	* @param component Component instance of which to get the name
33b34c43 PP	107	* @returns Returns a pointer to the component's name
d97bac96	108	*/
33b34c43	109	extern const char bt_component_get_name(struct bt_component component);
8738a040	110
d97bac96	111	/**
33b34c43	112	* Get component's class.
d97bac96	113	*
33b34c43 PP	114	* @param component Component instance of which to get the class
33b34c43 PP	115	* @returns The component's class
d97bac96	116	*/
33b34c43 PP	117	extern struct bt_component_class *bt_component_get_class(
33b34c43 PP	118	struct bt_component *component);
47e5a032	119
d3e4dcd8 PP	120	extern enum bt_component_class_type bt_component_get_class_type(
	121	struct bt_component *component);
	122
f60c8b34 JG	123	extern struct bt_graph bt_component_get_graph(struct bt_component component);
f60c8b34 JG	124
43de0e13 JG	125	#ifdef __cplusplus
	126	}
	127	#endif
	128
33b34c43	129	#endif /* BABELTRACE_COMPONENT_COMPONENT_H */