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

#ifndef BABELTRACE_PLUGIN_COMPONENT_H
#define BABELTRACE_PLUGIN_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/plugin/component-class.h>
#include <stdio.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
 * Status code. Errors are always negative.
 */
enum bt_component_status {
	/** Memory allocation failure. */
	BT_COMPONENT_STATUS_NOMEM =		-4,

	/** Invalid arguments. */
	BT_COMPONENT_STATUS_INVAL =		-3,

	/** Unsupported component feature. */
	BT_COMPONENT_STATUS_UNSUPPORTED =	-2,

	/** General error. */
	BT_COMPONENT_STATUS_ERROR =		-1,

	/** No error, okay. */
	BT_COMPONENT_STATUS_OK =		0,
};


struct bt_component;
struct bt_value;

/**
 * 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);

/**
 * 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);

/**
 * Set component's name.
 *
 * @param component	Component instance of which to set the name
 * @param name		New component name (will be copied)
 * @returns		One of #bt_component_status values
 */
extern enum bt_component_status bt_component_set_name(
		struct bt_component *component, const char *name);

/**
 * 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);

/**
 * Set component instance's error stream.
 *
 * @param component	Component instance
 * @param error_stream	Error stream
 * @returns		One of #bt_component_status values
 */
extern enum bt_component_status bt_component_set_error_stream(
		struct bt_component *component, FILE *error_stream);

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_PLUGIN_COMPONENT_H */
Commit	Line	Data
62ed7c30 JG	1	#ifndef BABELTRACE_PLUGIN_COMPONENT_H
	2	#define BABELTRACE_PLUGIN_COMPONENT_H
	3
	4	/*
633edee0	5	* BabelTrace - Babeltrace Component Interface
62ed7c30 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
fc11e32c	30	#include <babeltrace/plugin/component-class.h>
62ed7c30 JG	31	#include <stdio.h>
	32
	33	#ifdef __cplusplus
	34	extern "C" {
	35	#endif
	36
62ed7c30 JG	37	/**
	38	* Status code. Errors are always negative.
	39	*/
	40	enum bt_component_status {
	41	/** Memory allocation failure. */
fc11e32c	42	BT_COMPONENT_STATUS_NOMEM = -4,
62ed7c30 JG	43
62ed7c30 JG	44	/** Invalid arguments. */
fc11e32c	45	BT_COMPONENT_STATUS_INVAL = -3,
62ed7c30 JG	46
	47	/** Unsupported component feature. */
	48	BT_COMPONENT_STATUS_UNSUPPORTED = -2,
	49
	50	/** General error. */
	51	BT_COMPONENT_STATUS_ERROR = -1,
	52
	53	/** No error, okay. */
	54	BT_COMPONENT_STATUS_OK = 0,
	55	};
	56
62ed7c30	57
7c7c0433 JG	58	struct bt_component;
7c7c0433 JG	59	struct bt_value;
38b48196 JG	60
	61	/**
	62	* Create an instance of a component from a component class.
	63	*
	64	* @param component_class Component class of which to create an instance
	65	* @param name Name of the new component instance, optional
7c7c0433	66	* @param params A dictionary of component parameters
38b48196 JG	67	* @returns Returns a pointer to a new component instance
	68	*/
	69	extern struct bt_component *bt_component_create(
7c7c0433 JG	70	struct bt_component_class component_class, const char name,
7c7c0433 JG	71	struct bt_value *params);
38b48196	72
62ed7c30 JG	73	/**
	74	* Get component's name.
	75	*
	76	* @param component Component instance of which to get the name
633edee0	77	* @returns Returns a pointer to the component's name
62ed7c30 JG	78	*/
	79	extern const char bt_component_get_name(struct bt_component component);
	80
	81	/**
	82	* Set component's name.
	83	*
	84	* @param component Component instance of which to set the name
633edee0	85	* @param name New component name (will be copied)
62ed7c30 JG	86	* @returns One of #bt_component_status values
	87	*/
	88	extern enum bt_component_status bt_component_set_name(
	89	struct bt_component component, const char name);
	90
	91	/**
fc11e32c	92	* Get component's class.
62ed7c30	93	*
fc11e32c JG	94	* @param component Component instance of which to get the class
fc11e32c JG	95	* @returns The component's class
62ed7c30	96	*/
fc11e32c	97	extern struct bt_component_class *bt_component_get_class(
62ed7c30 JG	98	struct bt_component *component);
	99
	100	/**
fc11e32c	101	* Set component instance's error stream.
62ed7c30 JG	102	*
	103	* @param component Component instance
	104	* @param error_stream Error stream
	105	* @returns One of #bt_component_status values
	106	*/
	107	extern enum bt_component_status bt_component_set_error_stream(
	108	struct bt_component component, FILE error_stream);
	109
62ed7c30 JG	110	#ifdef __cplusplus
	111	}
	112	#endif
	113
	114	#endif /* BABELTRACE_PLUGIN_COMPONENT_H */