[babeltrace.git] / include / babeltrace2 / graph / component-class-source.h

#ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_SOURCE_H
#define BABELTRACE_GRAPH_COMPONENT_CLASS_SOURCE_H

/*
 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
 * 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 bt_self_component_status */
#include <babeltrace2/graph/self-component.h>

/* For bt_self_message_iterator_status */
#include <babeltrace2/graph/self-message-iterator.h>

/* For bt_query_status */
#include <babeltrace2/graph/component-class.h>

/* For bt_component_class_status */
#include <babeltrace2/graph/component-class-const.h>

/*
 * For bt_component_class, bt_component_class_source, bt_port_input,
 * bt_query_executor, bt_self_component_class_source,
 * bt_self_component_source, bt_self_component_port_output, bt_value,
 * bt_message_array_const, bt_bool, bt_self_message_iterator,
 * __BT_UPCAST
 */
#include <babeltrace2/types.h>

/* For bt_logging_level */
#include <babeltrace2/logging.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef bt_self_component_status
(*bt_component_class_source_init_method)(
		bt_self_component_source *self_component,
		const bt_value *params, void *init_method_data);

typedef void (*bt_component_class_source_finalize_method)(
		bt_self_component_source *self_component);

typedef bt_self_message_iterator_status
(*bt_component_class_source_message_iterator_init_method)(
		bt_self_message_iterator *message_iterator,
		bt_self_component_source *self_component,
		bt_self_component_port_output *port);

typedef void
(*bt_component_class_source_message_iterator_finalize_method)(
		bt_self_message_iterator *message_iterator);

typedef bt_self_message_iterator_status
(*bt_component_class_source_message_iterator_next_method)(
		bt_self_message_iterator *message_iterator,
		bt_message_array_const msgs, uint64_t capacity,
		uint64_t *count);

typedef bt_self_message_iterator_status
(*bt_component_class_source_message_iterator_seek_ns_from_origin_method)(
		bt_self_message_iterator *message_iterator,
		int64_t ns_from_origin);

typedef bt_self_message_iterator_status
(*bt_component_class_source_message_iterator_seek_beginning_method)(
		bt_self_message_iterator *message_iterator);

typedef bt_bool
(*bt_component_class_source_message_iterator_can_seek_ns_from_origin_method)(
		bt_self_message_iterator *message_iterator,
		int64_t ns_from_origin);

typedef bt_bool
(*bt_component_class_source_message_iterator_can_seek_beginning_method)(
		bt_self_message_iterator *message_iterator);

typedef bt_query_status (*bt_component_class_source_query_method)(
		bt_self_component_class_source *comp_class,
		const bt_query_executor *query_executor,
		const char *object, const bt_value *params,
		bt_logging_level logging_level,
		const bt_value **result);

typedef bt_self_component_status
(*bt_component_class_source_output_port_connected_method)(
		bt_self_component_source *self_component,
		bt_self_component_port_output *self_port,
		const bt_port_input *other_port);

static inline
bt_component_class *bt_component_class_source_as_component_class(
		bt_component_class_source *comp_cls_source)
{
	return __BT_UPCAST(bt_component_class, comp_cls_source);
}

extern
bt_component_class_source *bt_component_class_source_create(
		const char *name,
		bt_component_class_source_message_iterator_next_method method);

extern bt_component_class_status
bt_component_class_source_set_init_method(
		bt_component_class_source *comp_class,
		bt_component_class_source_init_method method);

extern bt_component_class_status
bt_component_class_source_set_finalize_method(
		bt_component_class_source *comp_class,
		bt_component_class_source_finalize_method method);

extern bt_component_class_status
bt_component_class_source_set_output_port_connected_method(
		bt_component_class_source *comp_class,
		bt_component_class_source_output_port_connected_method method);

extern bt_component_class_status
bt_component_class_source_set_query_method(
		bt_component_class_source *comp_class,
		bt_component_class_source_query_method method);

extern bt_component_class_status
bt_component_class_source_set_message_iterator_init_method(
		bt_component_class_source *comp_class,
		bt_component_class_source_message_iterator_init_method method);

extern bt_component_class_status
bt_component_class_source_set_message_iterator_finalize_method(
		bt_component_class_source *comp_class,
		bt_component_class_source_message_iterator_finalize_method method);

extern bt_component_class_status
bt_component_class_source_set_message_iterator_seek_ns_from_origin_method(
		bt_component_class_source *comp_class,
		bt_component_class_source_message_iterator_seek_ns_from_origin_method method);

extern bt_component_class_status
bt_component_class_source_set_message_iterator_seek_beginning_method(
		bt_component_class_source *comp_class,
		bt_component_class_source_message_iterator_seek_beginning_method method);

extern bt_bool
bt_component_class_source_set_message_iterator_can_seek_ns_from_origin_method(
		bt_component_class_source *comp_class,
		bt_component_class_source_message_iterator_can_seek_ns_from_origin_method method);

extern bt_bool
bt_component_class_source_set_message_iterator_can_seek_beginning_method(
		bt_component_class_source *comp_class,
		bt_component_class_source_message_iterator_can_seek_beginning_method method);

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_SOURCE_H */
Commit	Line	Data
1ca80abd PP	1	#ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_SOURCE_H
1ca80abd PP	2	#define BABELTRACE_GRAPH_COMPONENT_CLASS_SOURCE_H
d3e4dcd8 PP	3
d3e4dcd8 PP	4	/*
e2f7325d	5	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
d3e4dcd8 PP	6	* Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	7	*
	8	* Permission is hereby granted, free of charge, to any person obtaining a copy
	9	* of this software and associated documentation files (the "Software"), to deal
	10	* in the Software without restriction, including without limitation the rights
	11	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	12	* copies of the Software, and to permit persons to whom the Software is
	13	* furnished to do so, subject to the following conditions:
	14	*
	15	* The above copyright notice and this permission notice shall be included in
	16	* all copies or substantial portions of the Software.
	17	*
	18	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	19	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	20	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	21	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	22	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	23	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	24	* SOFTWARE.
	25	*/
	26
0d72b8c3 PP	27	#include <stdint.h>
0d72b8c3 PP	28
4cdfc5e8	29	/* For bt_self_component_status */
3fadfbc0	30	#include <babeltrace2/graph/self-component.h>
0d72b8c3	31
4cdfc5e8	32	/* For bt_self_message_iterator_status */
3fadfbc0	33	#include <babeltrace2/graph/self-message-iterator.h>
0d72b8c3	34
4cdfc5e8	35	/* For bt_query_status */
3fadfbc0	36	#include <babeltrace2/graph/component-class.h>
0d72b8c3	37
d0cf29ee	38	/* For bt_component_class_status */
3fadfbc0	39	#include <babeltrace2/graph/component-class-const.h>
d0cf29ee	40
b19ff26f PP	41	/*
	42	* For bt_component_class, bt_component_class_source, bt_port_input,
	43	* bt_query_executor, bt_self_component_class_source,
	44	* bt_self_component_source, bt_self_component_port_output, bt_value,
005f1204 PP	45	* bt_message_array_const, bt_bool, bt_self_message_iterator,
005f1204 PP	46	* __BT_UPCAST
b19ff26f	47	*/
3fadfbc0	48	#include <babeltrace2/types.h>
b19ff26f	49
f4e38e70 PP	50	/* For bt_logging_level */
	51	#include <babeltrace2/logging.h>
	52
d3e4dcd8 PP	53	#ifdef __cplusplus
	54	extern "C" {
	55	#endif
	56
4cdfc5e8	57	typedef bt_self_component_status
0d72b8c3	58	(*bt_component_class_source_init_method)(
b19ff26f PP	59	bt_self_component_source *self_component,
b19ff26f PP	60	const bt_value params, void init_method_data);
0d72b8c3 PP	61
0d72b8c3 PP	62	typedef void (*bt_component_class_source_finalize_method)(
b19ff26f	63	bt_self_component_source *self_component);
0d72b8c3	64
4cdfc5e8	65	typedef bt_self_message_iterator_status
d6e69534 PP	66	(*bt_component_class_source_message_iterator_init_method)(
d6e69534 PP	67	bt_self_message_iterator *message_iterator,
b19ff26f PP	68	bt_self_component_source *self_component,
b19ff26f PP	69	bt_self_component_port_output *port);
0d72b8c3 PP	70
0d72b8c3 PP	71	typedef void
d6e69534 PP	72	(*bt_component_class_source_message_iterator_finalize_method)(
d6e69534 PP	73	bt_self_message_iterator *message_iterator);
0d72b8c3	74
4cdfc5e8	75	typedef bt_self_message_iterator_status
d6e69534 PP	76	(*bt_component_class_source_message_iterator_next_method)(
	77	bt_self_message_iterator *message_iterator,
	78	bt_message_array_const msgs, uint64_t capacity,
0d72b8c3 PP	79	uint64_t *count);
0d72b8c3 PP	80
7474e7d3 PP	81	typedef bt_self_message_iterator_status
	82	(*bt_component_class_source_message_iterator_seek_ns_from_origin_method)(
	83	bt_self_message_iterator *message_iterator,
	84	int64_t ns_from_origin);
	85
	86	typedef bt_self_message_iterator_status
	87	(*bt_component_class_source_message_iterator_seek_beginning_method)(
	88	bt_self_message_iterator *message_iterator);
	89
	90	typedef bt_bool
	91	(*bt_component_class_source_message_iterator_can_seek_ns_from_origin_method)(
	92	bt_self_message_iterator *message_iterator,
	93	int64_t ns_from_origin);
	94
	95	typedef bt_bool
	96	(*bt_component_class_source_message_iterator_can_seek_beginning_method)(
	97	bt_self_message_iterator *message_iterator);
	98
4cdfc5e8	99	typedef bt_query_status (*bt_component_class_source_query_method)(
b19ff26f PP	100	bt_self_component_class_source *comp_class,
	101	const bt_query_executor *query_executor,
	102	const char object, const bt_value params,
f4e38e70	103	bt_logging_level logging_level,
b19ff26f	104	const bt_value **result);
0d72b8c3	105
4cdfc5e8	106	typedef bt_self_component_status
0d72b8c3	107	(*bt_component_class_source_output_port_connected_method)(
b19ff26f PP	108	bt_self_component_source *self_component,
	109	bt_self_component_port_output *self_port,
	110	const bt_port_input *other_port);
0d72b8c3	111
d94d92ac	112	static inline
b19ff26f PP	113	bt_component_class *bt_component_class_source_as_component_class(
b19ff26f PP	114	bt_component_class_source *comp_cls_source)
d94d92ac	115	{
005f1204	116	return __BT_UPCAST(bt_component_class, comp_cls_source);
d94d92ac	117	}
d3eb6e8f	118
0d72b8c3	119	extern
b19ff26f	120	bt_component_class_source *bt_component_class_source_create(
0d72b8c3	121	const char *name,
d6e69534	122	bt_component_class_source_message_iterator_next_method method);
0d72b8c3	123
d0cf29ee PP	124	extern bt_component_class_status
d0cf29ee PP	125	bt_component_class_source_set_init_method(
b19ff26f	126	bt_component_class_source *comp_class,
0d72b8c3 PP	127	bt_component_class_source_init_method method);
0d72b8c3 PP	128
d0cf29ee PP	129	extern bt_component_class_status
d0cf29ee PP	130	bt_component_class_source_set_finalize_method(
b19ff26f	131	bt_component_class_source *comp_class,
0d72b8c3 PP	132	bt_component_class_source_finalize_method method);
0d72b8c3 PP	133
d0cf29ee PP	134	extern bt_component_class_status
d0cf29ee PP	135	bt_component_class_source_set_output_port_connected_method(
b19ff26f	136	bt_component_class_source *comp_class,
0d72b8c3 PP	137	bt_component_class_source_output_port_connected_method method);
0d72b8c3 PP	138
d0cf29ee PP	139	extern bt_component_class_status
d0cf29ee PP	140	bt_component_class_source_set_query_method(
b19ff26f	141	bt_component_class_source *comp_class,
0d72b8c3 PP	142	bt_component_class_source_query_method method);
0d72b8c3 PP	143
d0cf29ee PP	144	extern bt_component_class_status
d0cf29ee PP	145	bt_component_class_source_set_message_iterator_init_method(
b19ff26f	146	bt_component_class_source *comp_class,
d6e69534	147	bt_component_class_source_message_iterator_init_method method);
0d72b8c3	148
d0cf29ee PP	149	extern bt_component_class_status
d0cf29ee PP	150	bt_component_class_source_set_message_iterator_finalize_method(
b19ff26f	151	bt_component_class_source *comp_class,
d6e69534	152	bt_component_class_source_message_iterator_finalize_method method);
0d72b8c3	153
7474e7d3 PP	154	extern bt_component_class_status
	155	bt_component_class_source_set_message_iterator_seek_ns_from_origin_method(
	156	bt_component_class_source *comp_class,
	157	bt_component_class_source_message_iterator_seek_ns_from_origin_method method);
	158
	159	extern bt_component_class_status
	160	bt_component_class_source_set_message_iterator_seek_beginning_method(
	161	bt_component_class_source *comp_class,
	162	bt_component_class_source_message_iterator_seek_beginning_method method);
	163
	164	extern bt_bool
	165	bt_component_class_source_set_message_iterator_can_seek_ns_from_origin_method(
	166	bt_component_class_source *comp_class,
	167	bt_component_class_source_message_iterator_can_seek_ns_from_origin_method method);
	168
	169	extern bt_bool
	170	bt_component_class_source_set_message_iterator_can_seek_beginning_method(
	171	bt_component_class_source *comp_class,
	172	bt_component_class_source_message_iterator_can_seek_beginning_method method);
	173
d3e4dcd8 PP	174	#ifdef __cplusplus
	175	}
	176	#endif
	177
1ca80abd	178	#endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_SOURCE_H */