[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
	1	#ifndef BABELTRACE_COMPONENT_COMPONENT_CLASS_H
	2	#define BABELTRACE_COMPONENT_COMPONENT_CLASS_H
	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
	28	#include <babeltrace/component/component.h>
	29	#include <stdint.h>
	30
	31	#ifdef __cplusplus
	32	extern "C" {
	33	#endif
	34
	35	struct bt_component_class;
	36	struct bt_component;
	37	struct bt_private_component;
	38	struct bt_private_port;
	39	struct bt_port;
	40	struct bt_value;
	41	struct bt_private_notification_iterator;
	42
	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)(
	60	struct bt_private_component *private_component,
	61	struct bt_value params, void init_method_data);
	62
	63	typedef void (*bt_component_class_finalize_method)(
	64	struct bt_private_component *private_component);
	65
	66	typedef enum bt_notification_iterator_status
	67	(*bt_component_class_notification_iterator_init_method)(
	68	struct bt_private_component *private_component,
	69	struct bt_private_port *private_port,
	70	struct bt_private_notification_iterator *private_notification_iterator);
	71
	72	typedef void (*bt_component_class_notification_iterator_finalize_method)(
	73	struct bt_private_notification_iterator *private_notification_iterator);
	74
	75	typedef struct bt_notification (bt_component_class_notification_iterator_get_method)(
	76	struct bt_private_notification_iterator *private_notification_iterator);
	77
	78	typedef enum bt_notification_iterator_status (*bt_component_class_notification_iterator_next_method)(
	79	struct bt_private_notification_iterator *private_notification_iterator);
	80
	81	typedef enum bt_notification_iterator_status
	82	(*bt_component_class_notification_iterator_seek_time_method)(
	83	struct bt_private_notification_iterator *private_notification_iterator,
	84	int64_t time);
	85
	86	typedef struct bt_value (bt_component_class_query_method)(
	87	struct bt_component_class *component_class,
	88	const char object, struct bt_value params);
	89
	90	typedef enum bt_component_status (*bt_component_class_accept_port_connection_method)(
	91	struct bt_private_component *private_component,
	92	struct bt_private_port *self_private_port,
	93	struct bt_port *other_port);
	94
	95	typedef void (*bt_component_class_port_disconnected_method)(
	96	struct bt_private_component *private_component,
	97	struct bt_private_port *private_port);
	98
	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
	103	extern int bt_component_class_set_finalize_method(
	104	struct bt_component_class *component_class,
	105	bt_component_class_finalize_method finalize_method);
	106
	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(
	112	struct bt_component_class *component_class,
	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);
	118
	119	extern int bt_component_class_set_description(
	120	struct bt_component_class *component_class,
	121	const char *description);
	122
	123	extern int bt_component_class_set_help(
	124	struct bt_component_class *component_class,
	125	const char *help);
	126
	127	extern int bt_component_class_freeze(
	128	struct bt_component_class *component_class);
	129
	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
	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	*/
	148	extern const char *bt_component_class_get_description(
	149	struct bt_component_class *component_class);
	150
	151	extern const char *bt_component_class_get_help(
	152	struct bt_component_class *component_class);
	153
	154	extern struct bt_value *bt_component_class_query(
	155	struct bt_component_class *component_class,
	156	const char object, struct bt_value params);
	157
	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	*/
	164	extern enum bt_component_class_type bt_component_class_get_type(
	165	struct bt_component_class *component_class);
	166
	167	#ifdef __cplusplus
	168	}
	169	#endif
	170
	171	#endif /* BABELTRACE_COMPONENT_COMPONENT_CLASS_H */