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

#ifndef BABELTRACE_COMPONENT_COMPONENT_CLASS_H
#define BABELTRACE_COMPONENT_COMPONENT_CLASS_H

/*
 * Babeltrace - Component Class Interface.
 *
 * Copyright 2016 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.h>
#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

struct bt_component_class;
struct bt_component;
struct bt_port;
struct bt_connection;
struct bt_value;
struct bt_notification_iterator;

/**
 * Component class type.
 */
enum bt_component_class_type {
	BT_COMPONENT_CLASS_TYPE_UNKNOWN =	-1,

	/** A source component is a notification generator. */
	BT_COMPONENT_CLASS_TYPE_SOURCE =	0,

	/** A sink component handles incoming notifications. */
	BT_COMPONENT_CLASS_TYPE_SINK =		1,

	/** A filter component implements both Source and Sink interfaces. */
	BT_COMPONENT_CLASS_TYPE_FILTER =	2,
};

typedef enum bt_component_status (*bt_component_class_init_method)(
		struct bt_component *component, struct bt_value *params,
		void *init_method_data);

typedef void (*bt_component_class_destroy_method)(struct bt_component *component);

typedef enum bt_notification_iterator_status
		(*bt_component_class_notification_iterator_init_method)(
		struct bt_component *component,
		struct bt_notification_iterator *iterator, void *init_method_data);

typedef void (*bt_component_class_notification_iterator_destroy_method)(
		struct bt_notification_iterator *iterator);

typedef struct bt_notification *(*bt_component_class_notification_iterator_get_method)(
		struct bt_notification_iterator *iterator);

typedef enum bt_notification_iterator_status (*bt_component_class_notification_iterator_next_method)(
		struct bt_notification_iterator *iterator);

typedef enum bt_notification_iterator_status
		(*bt_component_class_notification_iterator_seek_time_method)(
		struct bt_notification_iterator *iterator, int64_t time);

typedef struct bt_value *(*bt_component_class_query_method)(
		struct bt_component_class *component_class,
		const char *object, struct bt_value *params);

typedef enum bt_component_status (*bt_component_class_new_connection_method)(
		struct bt_port *own_port, struct bt_connection *connection);

extern int bt_component_class_set_init_method(
		struct bt_component_class *component_class,
		bt_component_class_init_method init_method);

extern int bt_component_class_set_destroy_method(
		struct bt_component_class *component_class,
		bt_component_class_destroy_method destroy_method);

extern int bt_component_class_set_new_connection_method(
		struct bt_component_class *component_class,
		bt_component_class_new_connection_method new_connection_method);

extern int bt_component_class_set_description(
		struct bt_component_class *component_class,
		const char *description);

extern int bt_component_class_set_help(
		struct bt_component_class *component_class,
		const char *help);

extern int bt_component_class_freeze(
		struct bt_component_class *component_class);

/**
 * Get a component class' name.
 *
 * @param component_class	Component class of which to get the name
 * @returns			Name of the component class
 */
extern const char *bt_component_class_get_name(
		struct bt_component_class *component_class);

/**
 * Get a component class' description.
 *
 * Component classes may provide an optional description. It may, however,
 * opt not to.
 *
 * @param component_class	Component class of which to get the description
 * @returns			Description of the component class, or NULL.
 */
extern const char *bt_component_class_get_description(
		struct bt_component_class *component_class);

extern const char *bt_component_class_get_help(
		struct bt_component_class *component_class);

extern int bt_component_class_set_query_method(
		struct bt_component_class *component_class,
		bt_component_class_query_method query_method);

extern int bt_component_class_set_new_connection_method(
		struct bt_component_class *component_class,
		bt_component_class_new_connection_method new_connection_method);

extern struct bt_value *bt_component_class_query(
		struct bt_component_class *component_class,
		const char *object, struct bt_value *params);

/**
 * Get a component class' type.
 *
 * @param component_class	Component class of which to get the type
 * @returns			One of #bt_component_type
 */
extern enum bt_component_class_type bt_component_class_get_type(
		struct bt_component_class *component_class);

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_COMPONENT_COMPONENT_CLASS_H */
Commit	Line	Data
33b34c43 PP	1	#ifndef BABELTRACE_COMPONENT_COMPONENT_CLASS_H
33b34c43 PP	2	#define BABELTRACE_COMPONENT_COMPONENT_CLASS_H
fc11e32c JG	3
	4	/*
	5	* Babeltrace - Component Class Interface.
	6	*
	7	* Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	8	*
	9	* Permission is hereby granted, free of charge, to any person obtaining a copy
	10	* of this software and associated documentation files (the "Software"), to deal
	11	* in the Software without restriction, including without limitation the rights
	12	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	13	* copies of the Software, and to permit persons to whom the Software is
	14	* furnished to do so, subject to the following conditions:
	15	*
	16	* The above copyright notice and this permission notice shall be included in
	17	* all copies or substantial portions of the Software.
	18	*
	19	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	20	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	21	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	22	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	23	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	24	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	25	* SOFTWARE.
	26	*/
	27
33b34c43	28	#include <babeltrace/component/component.h>
cd95962c	29	#include <stdint.h>
33b34c43	30
fc11e32c JG	31	#ifdef __cplusplus
	32	extern "C" {
	33	#endif
	34
fc11e32c	35	struct bt_component_class;
cd95962c JG	36	struct bt_component;
	37	struct bt_port;
	38	struct bt_connection;
	39	struct bt_value;
	40	struct bt_notification_iterator;
fc11e32c	41
d3e4dcd8 PP	42	/**
	43	* Component class type.
	44	*/
	45	enum bt_component_class_type {
	46	BT_COMPONENT_CLASS_TYPE_UNKNOWN = -1,
	47
	48	/** A source component is a notification generator. */
	49	BT_COMPONENT_CLASS_TYPE_SOURCE = 0,
	50
	51	/** A sink component handles incoming notifications. */
	52	BT_COMPONENT_CLASS_TYPE_SINK = 1,
	53
	54	/** A filter component implements both Source and Sink interfaces. */
	55	BT_COMPONENT_CLASS_TYPE_FILTER = 2,
	56	};
	57
	58	typedef enum bt_component_status (*bt_component_class_init_method)(
6358c163 PP	59	struct bt_component component, struct bt_value params,
6358c163 PP	60	void *init_method_data);
d3e4dcd8 PP	61
	62	typedef void (bt_component_class_destroy_method)(struct bt_component component);
	63
d3eb6e8f PP	64	typedef enum bt_notification_iterator_status
	65	(*bt_component_class_notification_iterator_init_method)(
	66	struct bt_component *component,
8b0ce102	67	struct bt_notification_iterator iterator, void init_method_data);
d3eb6e8f PP	68
	69	typedef void (*bt_component_class_notification_iterator_destroy_method)(
	70	struct bt_notification_iterator *iterator);
	71
	72	typedef struct bt_notification (bt_component_class_notification_iterator_get_method)(
	73	struct bt_notification_iterator *iterator);
	74
	75	typedef enum bt_notification_iterator_status (*bt_component_class_notification_iterator_next_method)(
	76	struct bt_notification_iterator *iterator);
	77
	78	typedef enum bt_notification_iterator_status
	79	(*bt_component_class_notification_iterator_seek_time_method)(
	80	struct bt_notification_iterator *iterator, int64_t time);
	81
a67681c1	82	typedef struct bt_value (bt_component_class_query_method)(
efa96d5d	83	struct bt_component_class *component_class,
a67681c1	84	const char object, struct bt_value params);
efa96d5d	85
2d41b99e JG	86	typedef enum bt_component_status (*bt_component_class_new_connection_method)(
	87	struct bt_port own_port, struct bt_connection connection);
	88
d3e4dcd8 PP	89	extern int bt_component_class_set_init_method(
	90	struct bt_component_class *component_class,
	91	bt_component_class_init_method init_method);
	92
	93	extern int bt_component_class_set_destroy_method(
	94	struct bt_component_class *component_class,
	95	bt_component_class_destroy_method destroy_method);
	96
2d41b99e JG	97	extern int bt_component_class_set_new_connection_method(
	98	struct bt_component_class *component_class,
	99	bt_component_class_new_connection_method new_connection_method);
	100
d3e4dcd8 PP	101	extern int bt_component_class_set_description(
	102	struct bt_component_class *component_class,
	103	const char *description);
38b48196	104
5536d9a6 PP	105	extern int bt_component_class_set_help(
	106	struct bt_component_class *component_class,
	107	const char *help);
	108
1e4d8103 PP	109	extern int bt_component_class_freeze(
	110	struct bt_component_class *component_class);
	111
38b48196 JG	112	/**
	113	* Get a component class' name.
	114	*
	115	* @param component_class Component class of which to get the name
	116	* @returns Name of the component class
	117	*/
	118	extern const char *bt_component_class_get_name(
	119	struct bt_component_class *component_class);
	120
7c7c0433 JG	121	/**
	122	* Get a component class' description.
	123	*
	124	* Component classes may provide an optional description. It may, however,
	125	* opt not to.
	126	*
	127	* @param component_class Component class of which to get the description
	128	* @returns Description of the component class, or NULL.
	129	*/
f3bc2010	130	extern const char *bt_component_class_get_description(
7c7c0433 JG	131	struct bt_component_class *component_class);
7c7c0433 JG	132
5536d9a6 PP	133	extern const char *bt_component_class_get_help(
	134	struct bt_component_class *component_class);
	135
a67681c1	136	extern int bt_component_class_set_query_method(
efa96d5d	137	struct bt_component_class *component_class,
a67681c1	138	bt_component_class_query_method query_method);
efa96d5d	139
2d41b99e JG	140	extern int bt_component_class_set_new_connection_method(
	141	struct bt_component_class *component_class,
	142	bt_component_class_new_connection_method new_connection_method);
	143
a67681c1	144	extern struct bt_value *bt_component_class_query(
efa96d5d	145	struct bt_component_class *component_class,
a67681c1	146	const char object, struct bt_value params);
efa96d5d	147
38b48196 JG	148	/**
	149	* Get a component class' type.
	150	*
	151	* @param component_class Component class of which to get the type
	152	* @returns One of #bt_component_type
	153	*/
d3e4dcd8	154	extern enum bt_component_class_type bt_component_class_get_type(
fc11e32c JG	155	struct bt_component_class *component_class);
fc11e32c JG	156
d3e4dcd8 PP	157	#ifdef __cplusplus
	158	}
	159	#endif
	160
33b34c43	161	#endif /* BABELTRACE_COMPONENT_COMPONENT_CLASS_H */