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

#ifndef BABELTRACE2_GRAPH_COMPONENT_CLASS_SOURCE_H
#define BABELTRACE2_GRAPH_COMPONENT_CLASS_SOURCE_H

/*
 * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
 *
 * 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.
 */

#ifndef __BT_IN_BABELTRACE_H
# error "Please include <babeltrace2/babeltrace.h> instead."
#endif

#include <stdint.h>

#include <babeltrace2/graph/component-class.h>
#include <babeltrace2/types.h>
#include <babeltrace2/logging.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef bt_component_class_init_method_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_component_class_message_iterator_init_method_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_component_class_message_iterator_next_method_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_component_class_message_iterator_seek_ns_from_origin_method_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_component_class_message_iterator_seek_beginning_method_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_component_class_query_method_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_component_class_port_connected_method_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_set_method_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_set_method_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_set_method_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_set_method_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_set_method_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_set_method_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_set_method_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_set_method_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_component_class_set_method_status
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_component_class_set_method_status
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 /* BABELTRACE2_GRAPH_COMPONENT_CLASS_SOURCE_H */
Commit	Line	Data
	1	#ifndef BABELTRACE2_GRAPH_COMPONENT_CLASS_SOURCE_H
	2	#define BABELTRACE2_GRAPH_COMPONENT_CLASS_SOURCE_H
	3
	4	/*
	5	* Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
	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	#ifndef __BT_IN_BABELTRACE_H
	27	# error "Please include <babeltrace2/babeltrace.h> instead."
	28	#endif
	29
	30	#include <stdint.h>
	31
	32	#include <babeltrace2/graph/component-class.h>
	33	#include <babeltrace2/types.h>
	34	#include <babeltrace2/logging.h>
	35
	36	#ifdef __cplusplus
	37	extern "C" {
	38	#endif
	39
	40	typedef bt_component_class_init_method_status
	41	(*bt_component_class_source_init_method)(
	42	bt_self_component_source *self_component,
	43	const bt_value params, void init_method_data);
	44
	45	typedef void (*bt_component_class_source_finalize_method)(
	46	bt_self_component_source *self_component);
	47
	48	typedef bt_component_class_message_iterator_init_method_status
	49	(*bt_component_class_source_message_iterator_init_method)(
	50	bt_self_message_iterator *message_iterator,
	51	bt_self_component_source *self_component,
	52	bt_self_component_port_output *port);
	53
	54	typedef void
	55	(*bt_component_class_source_message_iterator_finalize_method)(
	56	bt_self_message_iterator *message_iterator);
	57
	58	typedef bt_component_class_message_iterator_next_method_status
	59	(*bt_component_class_source_message_iterator_next_method)(
	60	bt_self_message_iterator *message_iterator,
	61	bt_message_array_const msgs, uint64_t capacity,
	62	uint64_t *count);
	63
	64	typedef bt_component_class_message_iterator_seek_ns_from_origin_method_status
	65	(*bt_component_class_source_message_iterator_seek_ns_from_origin_method)(
	66	bt_self_message_iterator *message_iterator,
	67	int64_t ns_from_origin);
	68
	69	typedef bt_component_class_message_iterator_seek_beginning_method_status
	70	(*bt_component_class_source_message_iterator_seek_beginning_method)(
	71	bt_self_message_iterator *message_iterator);
	72
	73	typedef bt_bool
	74	(*bt_component_class_source_message_iterator_can_seek_ns_from_origin_method)(
	75	bt_self_message_iterator *message_iterator,
	76	int64_t ns_from_origin);
	77
	78	typedef bt_bool
	79	(*bt_component_class_source_message_iterator_can_seek_beginning_method)(
	80	bt_self_message_iterator *message_iterator);
	81
	82	typedef bt_component_class_query_method_status
	83	(*bt_component_class_source_query_method)(
	84	bt_self_component_class_source *comp_class,
	85	const bt_query_executor *query_executor,
	86	const char object, const bt_value params,
	87	bt_logging_level logging_level,
	88	const bt_value **result);
	89
	90	typedef bt_component_class_port_connected_method_status
	91	(*bt_component_class_source_output_port_connected_method)(
	92	bt_self_component_source *self_component,
	93	bt_self_component_port_output *self_port,
	94	const bt_port_input *other_port);
	95
	96	static inline
	97	bt_component_class *bt_component_class_source_as_component_class(
	98	bt_component_class_source *comp_cls_source)
	99	{
	100	return __BT_UPCAST(bt_component_class, comp_cls_source);
	101	}
	102
	103	extern
	104	bt_component_class_source *bt_component_class_source_create(
	105	const char *name,
	106	bt_component_class_source_message_iterator_next_method method);
	107
	108	extern bt_component_class_set_method_status
	109	bt_component_class_source_set_init_method(
	110	bt_component_class_source *comp_class,
	111	bt_component_class_source_init_method method);
	112
	113	extern bt_component_class_set_method_status
	114	bt_component_class_source_set_finalize_method(
	115	bt_component_class_source *comp_class,
	116	bt_component_class_source_finalize_method method);
	117
	118	extern bt_component_class_set_method_status
	119	bt_component_class_source_set_output_port_connected_method(
	120	bt_component_class_source *comp_class,
	121	bt_component_class_source_output_port_connected_method method);
	122
	123	extern bt_component_class_set_method_status
	124	bt_component_class_source_set_query_method(
	125	bt_component_class_source *comp_class,
	126	bt_component_class_source_query_method method);
	127
	128	extern bt_component_class_set_method_status
	129	bt_component_class_source_set_message_iterator_init_method(
	130	bt_component_class_source *comp_class,
	131	bt_component_class_source_message_iterator_init_method method);
	132
	133	extern bt_component_class_set_method_status
	134	bt_component_class_source_set_message_iterator_finalize_method(
	135	bt_component_class_source *comp_class,
	136	bt_component_class_source_message_iterator_finalize_method method);
	137
	138	extern bt_component_class_set_method_status
	139	bt_component_class_source_set_message_iterator_seek_ns_from_origin_method(
	140	bt_component_class_source *comp_class,
	141	bt_component_class_source_message_iterator_seek_ns_from_origin_method method);
	142
	143	extern bt_component_class_set_method_status
	144	bt_component_class_source_set_message_iterator_seek_beginning_method(
	145	bt_component_class_source *comp_class,
	146	bt_component_class_source_message_iterator_seek_beginning_method method);
	147
	148	extern bt_component_class_set_method_status
	149	bt_component_class_source_set_message_iterator_can_seek_ns_from_origin_method(
	150	bt_component_class_source *comp_class,
	151	bt_component_class_source_message_iterator_can_seek_ns_from_origin_method method);
	152
	153	extern bt_component_class_set_method_status
	154	bt_component_class_source_set_message_iterator_can_seek_beginning_method(
	155	bt_component_class_source *comp_class,
	156	bt_component_class_source_message_iterator_can_seek_beginning_method method);
	157
	158	#ifdef __cplusplus
	159	}
	160	#endif
	161
	162	#endif /* BABELTRACE2_GRAPH_COMPONENT_CLASS_SOURCE_H */