[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_accept_output_port_connection_method)(
		bt_self_component_source *self_component,
		bt_self_component_port_output *self_port,
		const bt_port_input *other_port);

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_accept_output_port_connection_method(
		bt_component_class_source *comp_class,
		bt_component_class_source_accept_output_port_connection_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	/*
f2b0325d	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
7b53201c PP	27	#include <stdint.h>
7b53201c PP	28
ee78f405	29	/* For bt_self_component_status */
71c5da58	30	#include <babeltrace2/graph/self-component.h>
7b53201c	31
ee78f405	32	/* For bt_self_message_iterator_status */
71c5da58	33	#include <babeltrace2/graph/self-message-iterator.h>
7b53201c	34
ee78f405	35	/* For bt_query_status */
71c5da58	36	#include <babeltrace2/graph/component-class.h>
7b53201c	37
4d2e0cb5	38	/* For bt_component_class_status */
71c5da58	39	#include <babeltrace2/graph/component-class-const.h>
4d2e0cb5	40
8eee8ea2 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,
8470daa9 PP	45	* bt_message_array_const, bt_bool, bt_self_message_iterator,
8470daa9 PP	46	* __BT_UPCAST
8eee8ea2	47	*/
71c5da58	48	#include <babeltrace2/types.h>
8eee8ea2	49
83da519a PP	50	/* For bt_logging_level */
	51	#include <babeltrace2/logging.h>
	52
d3e4dcd8 PP	53	#ifdef __cplusplus
	54	extern "C" {
	55	#endif
	56
ee78f405	57	typedef bt_self_component_status
7b53201c	58	(*bt_component_class_source_init_method)(
8eee8ea2 PP	59	bt_self_component_source *self_component,
8eee8ea2 PP	60	const bt_value params, void init_method_data);
7b53201c PP	61
7b53201c PP	62	typedef void (*bt_component_class_source_finalize_method)(
8eee8ea2	63	bt_self_component_source *self_component);
7b53201c	64
ee78f405	65	typedef bt_self_message_iterator_status
b09a5592 PP	66	(*bt_component_class_source_message_iterator_init_method)(
b09a5592 PP	67	bt_self_message_iterator *message_iterator,
8eee8ea2 PP	68	bt_self_component_source *self_component,
8eee8ea2 PP	69	bt_self_component_port_output *port);
7b53201c PP	70
7b53201c PP	71	typedef void
b09a5592 PP	72	(*bt_component_class_source_message_iterator_finalize_method)(
b09a5592 PP	73	bt_self_message_iterator *message_iterator);
7b53201c	74
ee78f405	75	typedef bt_self_message_iterator_status
b09a5592 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,
7b53201c PP	79	uint64_t *count);
7b53201c PP	80
15a52f66 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
ee78f405	99	typedef bt_query_status (*bt_component_class_source_query_method)(
8eee8ea2 PP	100	bt_self_component_class_source *comp_class,
	101	const bt_query_executor *query_executor,
	102	const char object, const bt_value params,
83da519a	103	bt_logging_level logging_level,
8eee8ea2	104	const bt_value **result);
7b53201c	105
ee78f405	106	typedef bt_self_component_status
7b53201c	107	(*bt_component_class_source_accept_output_port_connection_method)(
8eee8ea2 PP	108	bt_self_component_source *self_component,
	109	bt_self_component_port_output *self_port,
	110	const bt_port_input *other_port);
7b53201c	111
ee78f405	112	typedef bt_self_component_status
7b53201c	113	(*bt_component_class_source_output_port_connected_method)(
8eee8ea2 PP	114	bt_self_component_source *self_component,
	115	bt_self_component_port_output *self_port,
	116	const bt_port_input *other_port);
7b53201c	117
834e9996	118	static inline
8eee8ea2 PP	119	bt_component_class *bt_component_class_source_as_component_class(
8eee8ea2 PP	120	bt_component_class_source *comp_cls_source)
834e9996	121	{
8470daa9	122	return __BT_UPCAST(bt_component_class, comp_cls_source);
834e9996	123	}
d3eb6e8f	124
7b53201c	125	extern
8eee8ea2	126	bt_component_class_source *bt_component_class_source_create(
7b53201c	127	const char *name,
b09a5592	128	bt_component_class_source_message_iterator_next_method method);
7b53201c	129
4d2e0cb5 PP	130	extern bt_component_class_status
4d2e0cb5 PP	131	bt_component_class_source_set_init_method(
8eee8ea2	132	bt_component_class_source *comp_class,
7b53201c PP	133	bt_component_class_source_init_method method);
7b53201c PP	134
4d2e0cb5 PP	135	extern bt_component_class_status
4d2e0cb5 PP	136	bt_component_class_source_set_finalize_method(
8eee8ea2	137	bt_component_class_source *comp_class,
7b53201c PP	138	bt_component_class_source_finalize_method method);
7b53201c PP	139
4d2e0cb5 PP	140	extern bt_component_class_status
4d2e0cb5 PP	141	bt_component_class_source_set_accept_output_port_connection_method(
8eee8ea2	142	bt_component_class_source *comp_class,
7b53201c PP	143	bt_component_class_source_accept_output_port_connection_method method);
7b53201c PP	144
4d2e0cb5 PP	145	extern bt_component_class_status
4d2e0cb5 PP	146	bt_component_class_source_set_output_port_connected_method(
8eee8ea2	147	bt_component_class_source *comp_class,
7b53201c PP	148	bt_component_class_source_output_port_connected_method method);
7b53201c PP	149
4d2e0cb5 PP	150	extern bt_component_class_status
4d2e0cb5 PP	151	bt_component_class_source_set_query_method(
8eee8ea2	152	bt_component_class_source *comp_class,
7b53201c PP	153	bt_component_class_source_query_method method);
7b53201c PP	154
4d2e0cb5 PP	155	extern bt_component_class_status
4d2e0cb5 PP	156	bt_component_class_source_set_message_iterator_init_method(
8eee8ea2	157	bt_component_class_source *comp_class,
b09a5592	158	bt_component_class_source_message_iterator_init_method method);
7b53201c	159
4d2e0cb5 PP	160	extern bt_component_class_status
4d2e0cb5 PP	161	bt_component_class_source_set_message_iterator_finalize_method(
8eee8ea2	162	bt_component_class_source *comp_class,
b09a5592	163	bt_component_class_source_message_iterator_finalize_method method);
7b53201c	164
15a52f66 PP	165	extern bt_component_class_status
	166	bt_component_class_source_set_message_iterator_seek_ns_from_origin_method(
	167	bt_component_class_source *comp_class,
	168	bt_component_class_source_message_iterator_seek_ns_from_origin_method method);
	169
	170	extern bt_component_class_status
	171	bt_component_class_source_set_message_iterator_seek_beginning_method(
	172	bt_component_class_source *comp_class,
	173	bt_component_class_source_message_iterator_seek_beginning_method method);
	174
	175	extern bt_bool
	176	bt_component_class_source_set_message_iterator_can_seek_ns_from_origin_method(
	177	bt_component_class_source *comp_class,
	178	bt_component_class_source_message_iterator_can_seek_ns_from_origin_method method);
	179
	180	extern bt_bool
	181	bt_component_class_source_set_message_iterator_can_seek_beginning_method(
	182	bt_component_class_source *comp_class,
	183	bt_component_class_source_message_iterator_can_seek_beginning_method method);
	184
d3e4dcd8 PP	185	#ifdef __cplusplus
	186	}
	187	#endif
	188
1ca80abd	189	#endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_SOURCE_H */