[babeltrace.git] / include / babeltrace / graph / port-output-message-iterator.h

#ifndef BABELTRACE_GRAPH_PORT_OUTPUT_MESSAGE_ITERATOR_H
#define BABELTRACE_GRAPH_PORT_OUTPUT_MESSAGE_ITERATOR_H

/*
 * Copyright 2017-2018 Philippe Proulx <pproulx@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_message_iterator_status */
#include <babeltrace/graph/message-iterator-const.h>

/*
 * For bt_port, bt_message, bt_message_iterator,
 * bt_port_output_message_iterator, bt_graph, bt_port_output,
 * bt_message_array_const, bt_bool, __BT_UPCAST
 */
#include <babeltrace/types.h>

#ifdef __cplusplus
extern "C" {
#endif

static inline
bt_message_iterator *
bt_port_output_message_iterator_as_message_iterator(
		bt_port_output_message_iterator *iterator)
{
	return __BT_UPCAST(bt_message_iterator, iterator);
}

extern bt_port_output_message_iterator *
bt_port_output_message_iterator_create(
		bt_graph *graph,
		const bt_port_output *output_port);

extern bt_message_iterator_status
bt_port_output_message_iterator_next(
		bt_port_output_message_iterator *iterator,
		bt_message_array_const *msgs, uint64_t *count);

extern bt_bool bt_port_output_message_iterator_can_seek_ns_from_origin(
		bt_port_output_message_iterator *iterator,
		int64_t ns_from_origin);

extern bt_bool bt_port_output_message_iterator_can_seek_beginning(
		bt_port_output_message_iterator *iterator);

extern bt_message_iterator_status
bt_port_output_message_iterator_seek_ns_from_origin(
		bt_port_output_message_iterator *iterator,
		int64_t ns_from_origin);

extern bt_message_iterator_status
bt_port_output_message_iterator_seek_beginning(
		bt_port_output_message_iterator *iterator);

extern void bt_port_output_message_iterator_get_ref(
		const bt_port_output_message_iterator *port_output_message_iterator);

extern void bt_port_output_message_iterator_put_ref(
		const bt_port_output_message_iterator *port_output_message_iterator);

#define BT_PORT_OUTPUT_MESSAGE_ITERATOR_PUT_REF_AND_RESET(_var)	\
	do {								\
		bt_port_output_message_iterator_put_ref(_var);	\
		(_var) = NULL;						\
	} while (0)

#define BT_PORT_OUTPUT_MESSAGE_ITERATOR_MOVE_REF(_var_dst, _var_src) \
	do {								\
		bt_port_output_message_iterator_put_ref(_var_dst);	\
		(_var_dst) = (_var_src);				\
		(_var_src) = NULL;					\
	} while (0)

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_GRAPH_PORT_OUTPUT_MESSAGE_ITERATOR_H */
Commit	Line	Data
d6e69534 PP	1	#ifndef BABELTRACE_GRAPH_PORT_OUTPUT_MESSAGE_ITERATOR_H
d6e69534 PP	2	#define BABELTRACE_GRAPH_PORT_OUTPUT_MESSAGE_ITERATOR_H
706a18f9 PP	3
706a18f9 PP	4	/*
e2f7325d	5	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
706a18f9 PP	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
d94d92ac PP	26	#include <stdint.h>
d94d92ac PP	27
4cdfc5e8	28	/* For bt_message_iterator_status */
7474e7d3	29	#include <babeltrace/graph/message-iterator-const.h>
9d408fca	30
b19ff26f	31	/*
d6e69534 PP	32	* For bt_port, bt_message, bt_message_iterator,
d6e69534 PP	33	* bt_port_output_message_iterator, bt_graph, bt_port_output,
005f1204	34	* bt_message_array_const, bt_bool, __BT_UPCAST
b19ff26f PP	35	*/
b19ff26f PP	36	#include <babeltrace/types.h>
d94d92ac	37
706a18f9 PP	38	#ifdef __cplusplus
	39	extern "C" {
	40	#endif
	41
d94d92ac	42	static inline
d6e69534 PP	43	bt_message_iterator *
	44	bt_port_output_message_iterator_as_message_iterator(
	45	bt_port_output_message_iterator *iterator)
d94d92ac	46	{
005f1204	47	return __BT_UPCAST(bt_message_iterator, iterator);
d94d92ac	48	}
706a18f9	49
d6e69534 PP	50	extern bt_port_output_message_iterator *
d6e69534 PP	51	bt_port_output_message_iterator_create(
b19ff26f PP	52	bt_graph *graph,
b19ff26f PP	53	const bt_port_output *output_port);
706a18f9	54
4cdfc5e8	55	extern bt_message_iterator_status
d6e69534 PP	56	bt_port_output_message_iterator_next(
	57	bt_port_output_message_iterator *iterator,
	58	bt_message_array_const msgs, uint64_t count);
07245ac2	59
7474e7d3 PP	60	extern bt_bool bt_port_output_message_iterator_can_seek_ns_from_origin(
	61	bt_port_output_message_iterator *iterator,
	62	int64_t ns_from_origin);
	63
	64	extern bt_bool bt_port_output_message_iterator_can_seek_beginning(
	65	bt_port_output_message_iterator *iterator);
	66
	67	extern bt_message_iterator_status
	68	bt_port_output_message_iterator_seek_ns_from_origin(
	69	bt_port_output_message_iterator *iterator,
	70	int64_t ns_from_origin);
	71
	72	extern bt_message_iterator_status
	73	bt_port_output_message_iterator_seek_beginning(
	74	bt_port_output_message_iterator *iterator);
	75
d6e69534 PP	76	extern void bt_port_output_message_iterator_get_ref(
d6e69534 PP	77	const bt_port_output_message_iterator *port_output_message_iterator);
c5b9b441	78
d6e69534 PP	79	extern void bt_port_output_message_iterator_put_ref(
d6e69534 PP	80	const bt_port_output_message_iterator *port_output_message_iterator);
c5b9b441	81
d6e69534	82	#define BT_PORT_OUTPUT_MESSAGE_ITERATOR_PUT_REF_AND_RESET(_var) \
c5b9b441	83	do { \
d6e69534	84	bt_port_output_message_iterator_put_ref(_var); \
c5b9b441 PP	85	(_var) = NULL; \
	86	} while (0)
	87
d6e69534	88	#define BT_PORT_OUTPUT_MESSAGE_ITERATOR_MOVE_REF(_var_dst, _var_src) \
c5b9b441	89	do { \
d6e69534	90	bt_port_output_message_iterator_put_ref(_var_dst); \
c5b9b441 PP	91	(_var_dst) = (_var_src); \
	92	(_var_src) = NULL; \
	93	} while (0)
	94
706a18f9 PP	95	#ifdef __cplusplus
	96	}
	97	#endif
	98
d6e69534	99	#endif /* BABELTRACE_GRAPH_PORT_OUTPUT_MESSAGE_ITERATOR_H */