[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_private_component;
struct bt_private_port;
struct bt_port;
struct bt_value;
struct bt_private_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_private_component *private_component,
		struct bt_value *params, void *init_method_data);

typedef void (*bt_component_class_finalize_method)(
		struct bt_private_component *private_component);

typedef enum bt_notification_iterator_status
		(*bt_component_class_notification_iterator_init_method)(
		struct bt_private_component *private_component,
		struct bt_private_port *private_port,
		struct bt_private_notification_iterator *private_notification_iterator);

typedef void (*bt_component_class_notification_iterator_finalize_method)(
		struct bt_private_notification_iterator *private_notification_iterator);

typedef struct bt_notification *(*bt_component_class_notification_iterator_get_method)(
		struct bt_private_notification_iterator *private_notification_iterator);

typedef enum bt_notification_iterator_status (*bt_component_class_notification_iterator_next_method)(
		struct bt_private_notification_iterator *private_notification_iterator);

typedef enum bt_notification_iterator_status
		(*bt_component_class_notification_iterator_seek_time_method)(
		struct bt_private_notification_iterator *private_notification_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_accept_port_connection_method)(
		struct bt_private_component *private_component,
		struct bt_private_port *self_private_port,
		struct bt_port *other_port);

typedef void (*bt_component_class_port_disconnected_method)(
		struct bt_private_component *private_component,
		struct bt_private_port *private_port);

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_finalize_method(
		struct bt_component_class *component_class,
		bt_component_class_finalize_method finalize_method);

extern int bt_component_class_set_accept_port_connection_method(
		struct bt_component_class *component_class,
		bt_component_class_accept_port_connection_method accept_port_connection_method);

extern int bt_component_class_set_port_disconnected_method(
		struct bt_component_class *component_class,
		bt_component_class_port_disconnected_method port_disconnected_method);

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_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 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	36	struct bt_component;
890882ef PP	37	struct bt_private_component;
890882ef PP	38	struct bt_private_port;
8f4799f7	39	struct bt_port;
cd95962c	40	struct bt_value;
890882ef	41	struct bt_private_notification_iterator;
fc11e32c	42
d3e4dcd8 PP	43	/**
	44	* Component class type.
	45	*/
	46	enum bt_component_class_type {
	47	BT_COMPONENT_CLASS_TYPE_UNKNOWN = -1,
	48
	49	/** A source component is a notification generator. */
	50	BT_COMPONENT_CLASS_TYPE_SOURCE = 0,
	51
	52	/** A sink component handles incoming notifications. */
	53	BT_COMPONENT_CLASS_TYPE_SINK = 1,
	54
	55	/** A filter component implements both Source and Sink interfaces. */
	56	BT_COMPONENT_CLASS_TYPE_FILTER = 2,
	57	};
	58
	59	typedef enum bt_component_status (*bt_component_class_init_method)(
890882ef PP	60	struct bt_private_component *private_component,
890882ef PP	61	struct bt_value params, void init_method_data);
d3e4dcd8	62
64cadc66	63	typedef void (*bt_component_class_finalize_method)(
890882ef	64	struct bt_private_component *private_component);
d3e4dcd8	65
d3eb6e8f PP	66	typedef enum bt_notification_iterator_status
d3eb6e8f PP	67	(*bt_component_class_notification_iterator_init_method)(
890882ef PP	68	struct bt_private_component *private_component,
	69	struct bt_private_port *private_port,
	70	struct bt_private_notification_iterator *private_notification_iterator);
d3eb6e8f	71
64cadc66	72	typedef void (*bt_component_class_notification_iterator_finalize_method)(
890882ef	73	struct bt_private_notification_iterator *private_notification_iterator);
d3eb6e8f PP	74
d3eb6e8f PP	75	typedef struct bt_notification (bt_component_class_notification_iterator_get_method)(
890882ef	76	struct bt_private_notification_iterator *private_notification_iterator);
d3eb6e8f PP	77
d3eb6e8f PP	78	typedef enum bt_notification_iterator_status (*bt_component_class_notification_iterator_next_method)(
890882ef	79	struct bt_private_notification_iterator *private_notification_iterator);
d3eb6e8f PP	80
	81	typedef enum bt_notification_iterator_status
	82	(*bt_component_class_notification_iterator_seek_time_method)(
890882ef PP	83	struct bt_private_notification_iterator *private_notification_iterator,
890882ef PP	84	int64_t time);
d3eb6e8f	85
a67681c1	86	typedef struct bt_value (bt_component_class_query_method)(
efa96d5d	87	struct bt_component_class *component_class,
a67681c1	88	const char object, struct bt_value params);
efa96d5d	89
72b913fb	90	typedef enum bt_component_status (*bt_component_class_accept_port_connection_method)(
890882ef	91	struct bt_private_component *private_component,
8f4799f7 PP	92	struct bt_private_port *self_private_port,
8f4799f7 PP	93	struct bt_port *other_port);
72b913fb PP	94
72b913fb PP	95	typedef void (*bt_component_class_port_disconnected_method)(
890882ef PP	96	struct bt_private_component *private_component,
890882ef PP	97	struct bt_private_port *private_port);
2d41b99e	98
d3e4dcd8 PP	99	extern int bt_component_class_set_init_method(
	100	struct bt_component_class *component_class,
	101	bt_component_class_init_method init_method);
	102
64cadc66	103	extern int bt_component_class_set_finalize_method(
d3e4dcd8	104	struct bt_component_class *component_class,
64cadc66	105	bt_component_class_finalize_method finalize_method);
d3e4dcd8	106
72b913fb PP	107	extern int bt_component_class_set_accept_port_connection_method(
	108	struct bt_component_class *component_class,
	109	bt_component_class_accept_port_connection_method accept_port_connection_method);
	110
	111	extern int bt_component_class_set_port_disconnected_method(
2d41b99e	112	struct bt_component_class *component_class,
72b913fb PP	113	bt_component_class_port_disconnected_method port_disconnected_method);
	114
	115	extern int bt_component_class_set_query_method(
	116	struct bt_component_class *component_class,
	117	bt_component_class_query_method query_method);
2d41b99e	118
d3e4dcd8 PP	119	extern int bt_component_class_set_description(
	120	struct bt_component_class *component_class,
	121	const char *description);
38b48196	122
5536d9a6 PP	123	extern int bt_component_class_set_help(
	124	struct bt_component_class *component_class,
	125	const char *help);
	126
1e4d8103 PP	127	extern int bt_component_class_freeze(
	128	struct bt_component_class *component_class);
	129
38b48196 JG	130	/**
	131	* Get a component class' name.
	132	*
	133	* @param component_class Component class of which to get the name
	134	* @returns Name of the component class
	135	*/
	136	extern const char *bt_component_class_get_name(
	137	struct bt_component_class *component_class);
	138
7c7c0433 JG	139	/**
	140	* Get a component class' description.
	141	*
	142	* Component classes may provide an optional description. It may, however,
	143	* opt not to.
	144	*
	145	* @param component_class Component class of which to get the description
	146	* @returns Description of the component class, or NULL.
	147	*/
f3bc2010	148	extern const char *bt_component_class_get_description(
7c7c0433 JG	149	struct bt_component_class *component_class);
7c7c0433 JG	150
5536d9a6 PP	151	extern const char *bt_component_class_get_help(
	152	struct bt_component_class *component_class);
	153
a67681c1	154	extern struct bt_value *bt_component_class_query(
efa96d5d	155	struct bt_component_class *component_class,
a67681c1	156	const char object, struct bt_value params);
efa96d5d	157
38b48196 JG	158	/**
	159	* Get a component class' type.
	160	*
	161	* @param component_class Component class of which to get the type
	162	* @returns One of #bt_component_type
	163	*/
d3e4dcd8	164	extern enum bt_component_class_type bt_component_class_get_type(
fc11e32c JG	165	struct bt_component_class *component_class);
fc11e32c JG	166
d3e4dcd8 PP	167	#ifdef __cplusplus
	168	}
	169	#endif
	170
33b34c43	171	#endif /* BABELTRACE_COMPONENT_COMPONENT_CLASS_H */