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

#ifndef BABELTRACE_GRAPH_COMPONENT_SINK_CONST_H
#define BABELTRACE_GRAPH_COMPONENT_SINK_CONST_H

/*
 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
 * Copyright 2017 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_component, bt_component_filter, bt_port_input,
 * __BT_UPCAST_CONST, bt_component_class_sink
 */
#include <babeltrace/types.h>

#ifdef __cplusplus
extern "C" {
#endif

static inline
const bt_component *bt_component_sink_as_component_const(
		const bt_component_sink *component)
{
	return __BT_UPCAST_CONST(bt_component, component);
}

extern const bt_component_class_sink *
bt_component_sink_borrow_class_const(
		const bt_component_sink *component);

extern uint64_t bt_component_sink_get_input_port_count(
		const bt_component_sink *component);

extern const bt_port_input *
bt_component_sink_borrow_input_port_by_name_const(
		const bt_component_sink *component, const char *name);

extern const bt_port_input *
bt_component_sink_borrow_input_port_by_index_const(
		const bt_component_sink *component, uint64_t index);

extern void bt_component_sink_get_ref(
		const bt_component_sink *component_sink);

extern void bt_component_sink_put_ref(
		const bt_component_sink *component_sink);

#define BT_COMPONENT_SINK_PUT_REF_AND_RESET(_var)		\
	do {							\
		bt_component_sink_put_ref(_var);		\
		(_var) = NULL;					\
	} while (0)

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

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_GRAPH_COMPONENT_SINK_CONST_H */
Commit	Line	Data
	1	#ifndef BABELTRACE_GRAPH_COMPONENT_SINK_CONST_H
	2	#define BABELTRACE_GRAPH_COMPONENT_SINK_CONST_H
	3
	4	/*
	5	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
	6	* Copyright 2017 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
	27	#include <stdint.h>
	28
	29	/*
	30	* For bt_component, bt_component_filter, bt_port_input,
	31	* __BT_UPCAST_CONST, bt_component_class_sink
	32	*/
	33	#include <babeltrace/types.h>
	34
	35	#ifdef __cplusplus
	36	extern "C" {
	37	#endif
	38
	39	static inline
	40	const bt_component *bt_component_sink_as_component_const(
	41	const bt_component_sink *component)
	42	{
	43	return __BT_UPCAST_CONST(bt_component, component);
	44	}
	45
	46	extern const bt_component_class_sink *
	47	bt_component_sink_borrow_class_const(
	48	const bt_component_sink *component);
	49
	50	extern uint64_t bt_component_sink_get_input_port_count(
	51	const bt_component_sink *component);
	52
	53	extern const bt_port_input *
	54	bt_component_sink_borrow_input_port_by_name_const(
	55	const bt_component_sink component, const char name);
	56
	57	extern const bt_port_input *
	58	bt_component_sink_borrow_input_port_by_index_const(
	59	const bt_component_sink *component, uint64_t index);
	60
	61	extern void bt_component_sink_get_ref(
	62	const bt_component_sink *component_sink);
	63
	64	extern void bt_component_sink_put_ref(
	65	const bt_component_sink *component_sink);
	66
	67	#define BT_COMPONENT_SINK_PUT_REF_AND_RESET(_var) \
	68	do { \
	69	bt_component_sink_put_ref(_var); \
	70	(_var) = NULL; \
	71	} while (0)
	72
	73	#define BT_COMPONENT_SINK_MOVE_REF(_var_dst, _var_src) \
	74	do { \
	75	bt_component_sink_put_ref(_var_dst); \
	76	(_var_dst) = (_var_src); \
	77	(_var_src) = NULL; \
	78	} while (0)
	79
	80	#ifdef __cplusplus
	81	}
	82	#endif
	83
	84	#endif /* BABELTRACE_GRAPH_COMPONENT_SINK_CONST_H */