[babeltrace.git] / include / babeltrace / graph / private-component-class-sink.h

#ifndef BABELTRACE_GRAPH_PRIVATE_COMPONENT_CLASS_SINK_H
#define BABELTRACE_GRAPH_PRIVATE_COMPONENT_CLASS_SINK_H

/*
 * 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 <stdint.h>

/* For enum bt_notification_array */
#include <babeltrace/graph/notification.h>

/* For enum bt_self_component_status */
#include <babeltrace/graph/self-component.h>

/* For enum bt_query_status */
#include <babeltrace/graph/private-component-class.h>

#ifdef __cplusplus
extern "C" {
#endif

struct bt_self_component_class_sink;
struct bt_component_class_sink;
struct bt_self_component_sink;
struct bt_private_component_class;
struct bt_private_component_class_sink;
struct bt_self_component_port_input;
struct bt_port_output;
struct bt_query_executor;
struct bt_value;

typedef enum bt_self_component_status
(*bt_private_component_class_sink_init_method)(
		struct bt_self_component_sink *self_component,
		const struct bt_value *params, void *init_method_data);

typedef void (*bt_private_component_class_sink_finalize_method)(
		struct bt_self_component_sink *self_component);

typedef enum bt_query_status
(*bt_private_component_class_sink_query_method)(
		struct bt_self_component_class_sink *comp_class,
		struct bt_query_executor *query_executor,
		const char *object, const struct bt_value *params,
		const struct bt_value **result);

typedef enum bt_self_component_status
(*bt_private_component_class_sink_accept_input_port_connection_method)(
		struct bt_self_component_sink *self_component,
		struct bt_self_component_port_input *self_port,
		struct bt_port_output *other_port);

typedef enum bt_self_component_status
(*bt_private_component_class_sink_input_port_connected_method)(
		struct bt_self_component_sink *self_component,
		struct bt_self_component_port_input *self_port,
		struct bt_port_output *other_port);

typedef void
(*bt_private_component_class_sink_input_port_disconnected_method)(
		struct bt_self_component_sink *self_component,
		struct bt_self_component_port_input *self_port);

typedef enum bt_self_component_status
(*bt_private_component_class_sink_consume_method)(
	struct bt_self_component_sink *self_component);

static inline
struct bt_private_component_class *
bt_private_component_class_sink_as_private_component_class(
		struct bt_private_component_class_sink *priv_comp_cls_sink)
{
	return (void *) priv_comp_cls_sink;
}

static inline
struct bt_component_class_sink *
bt_private_component_class_sink_as_component_class_sink(
		struct bt_private_component_class_sink *priv_comp_cls_sink)
{
	return (void *) priv_comp_cls_sink;
}

extern
struct bt_private_component_class_sink *bt_private_component_class_sink_create(
		const char *name,
		bt_private_component_class_sink_consume_method method);

extern int bt_private_component_class_sink_set_init_method(
		struct bt_private_component_class_sink *comp_class,
		bt_private_component_class_sink_init_method method);

extern int bt_private_component_class_sink_set_finalize_method(
		struct bt_private_component_class_sink *comp_class,
		bt_private_component_class_sink_finalize_method method);

extern int bt_private_component_class_sink_set_accept_input_port_connection_method(
		struct bt_private_component_class_sink *comp_class,
		bt_private_component_class_sink_accept_input_port_connection_method method);

extern int bt_private_component_class_sink_set_input_port_connected_method(
		struct bt_private_component_class_sink *comp_class,
		bt_private_component_class_sink_input_port_connected_method method);

extern int bt_private_component_class_sink_set_input_port_disconnected_method(
		struct bt_private_component_class_sink *comp_class,
		bt_private_component_class_sink_input_port_disconnected_method method);

extern int bt_private_component_class_sink_set_query_method(
		struct bt_private_component_class_sink *comp_class,
		bt_private_component_class_sink_query_method method);

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_GRAPH_PRIVATE_COMPONENT_CLASS_SINK_H */
Commit	Line	Data
d94d92ac PP	1	#ifndef BABELTRACE_GRAPH_PRIVATE_COMPONENT_CLASS_SINK_H
	2	#define BABELTRACE_GRAPH_PRIVATE_COMPONENT_CLASS_SINK_H
	3
	4	/*
	5	* Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	6	*
	7	* Permission is hereby granted, free of charge, to any person obtaining a copy
	8	* of this software and associated documentation files (the "Software"), to deal
	9	* in the Software without restriction, including without limitation the rights
	10	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	11	* copies of the Software, and to permit persons to whom the Software is
	12	* furnished to do so, subject to the following conditions:
	13	*
	14	* The above copyright notice and this permission notice shall be included in
	15	* all copies or substantial portions of the Software.
	16	*
	17	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	18	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	19	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	20	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	21	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	22	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	23	* SOFTWARE.
	24	*/
	25
	26	#include <stdint.h>
	27
	28	/* For enum bt_notification_array */
	29	#include <babeltrace/graph/notification.h>
	30
	31	/* For enum bt_self_component_status */
	32	#include <babeltrace/graph/self-component.h>
	33
	34	/* For enum bt_query_status */
d94d92ac PP	35	#include <babeltrace/graph/private-component-class.h>
	36
	37	#ifdef __cplusplus
	38	extern "C" {
	39	#endif
	40
	41	struct bt_self_component_class_sink;
	42	struct bt_component_class_sink;
	43	struct bt_self_component_sink;
	44	struct bt_private_component_class;
	45	struct bt_private_component_class_sink;
	46	struct bt_self_component_port_input;
	47	struct bt_port_output;
	48	struct bt_query_executor;
	49	struct bt_value;
	50
	51	typedef enum bt_self_component_status
	52	(*bt_private_component_class_sink_init_method)(
	53	struct bt_self_component_sink *self_component,
05e21286	54	const struct bt_value params, void init_method_data);
d94d92ac PP	55
	56	typedef void (*bt_private_component_class_sink_finalize_method)(
	57	struct bt_self_component_sink *self_component);
	58
	59	typedef enum bt_query_status
	60	(*bt_private_component_class_sink_query_method)(
	61	struct bt_self_component_class_sink *comp_class,
	62	struct bt_query_executor *query_executor,
05e21286 PP	63	const char object, const struct bt_value params,
05e21286 PP	64	const struct bt_value **result);
d94d92ac PP	65
	66	typedef enum bt_self_component_status
	67	(*bt_private_component_class_sink_accept_input_port_connection_method)(
	68	struct bt_self_component_sink *self_component,
	69	struct bt_self_component_port_input *self_port,
	70	struct bt_port_output *other_port);
	71
	72	typedef enum bt_self_component_status
	73	(*bt_private_component_class_sink_input_port_connected_method)(
	74	struct bt_self_component_sink *self_component,
	75	struct bt_self_component_port_input *self_port,
	76	struct bt_port_output *other_port);
	77
	78	typedef void
	79	(*bt_private_component_class_sink_input_port_disconnected_method)(
	80	struct bt_self_component_sink *self_component,
	81	struct bt_self_component_port_input *self_port);
	82
	83	typedef enum bt_self_component_status
	84	(*bt_private_component_class_sink_consume_method)(
	85	struct bt_self_component_sink *self_component);
	86
	87	static inline
	88	struct bt_private_component_class *
707b7d35	89	bt_private_component_class_sink_as_private_component_class(
d94d92ac PP	90	struct bt_private_component_class_sink *priv_comp_cls_sink)
	91	{
	92	return (void *) priv_comp_cls_sink;
	93	}
	94
	95	static inline
	96	struct bt_component_class_sink *
707b7d35	97	bt_private_component_class_sink_as_component_class_sink(
d94d92ac PP	98	struct bt_private_component_class_sink *priv_comp_cls_sink)
	99	{
	100	return (void *) priv_comp_cls_sink;
	101	}
	102
	103	extern
	104	struct bt_private_component_class_sink *bt_private_component_class_sink_create(
	105	const char *name,
	106	bt_private_component_class_sink_consume_method method);
	107
	108	extern int bt_private_component_class_sink_set_init_method(
	109	struct bt_private_component_class_sink *comp_class,
	110	bt_private_component_class_sink_init_method method);
	111
	112	extern int bt_private_component_class_sink_set_finalize_method(
	113	struct bt_private_component_class_sink *comp_class,
	114	bt_private_component_class_sink_finalize_method method);
	115
	116	extern int bt_private_component_class_sink_set_accept_input_port_connection_method(
	117	struct bt_private_component_class_sink *comp_class,
	118	bt_private_component_class_sink_accept_input_port_connection_method method);
	119
	120	extern int bt_private_component_class_sink_set_input_port_connected_method(
	121	struct bt_private_component_class_sink *comp_class,
	122	bt_private_component_class_sink_input_port_connected_method method);
	123
	124	extern int bt_private_component_class_sink_set_input_port_disconnected_method(
	125	struct bt_private_component_class_sink *comp_class,
	126	bt_private_component_class_sink_input_port_disconnected_method method);
	127
	128	extern int bt_private_component_class_sink_set_query_method(
	129	struct bt_private_component_class_sink *comp_class,
	130	bt_private_component_class_sink_query_method method);
	131
	132	#ifdef __cplusplus
	133	}
	134	#endif
	135
	136	#endif /* BABELTRACE_GRAPH_PRIVATE_COMPONENT_CLASS_SINK_H */