[babeltrace.git] / include / babeltrace2 / graph / message-const.h

#ifndef BABELTRACE2_GRAPH_MESSAGE_CONST_H
#define BABELTRACE2_GRAPH_MESSAGE_CONST_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 <babeltrace2/types.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
 * Message types. Unhandled message types should be ignored.
 */
typedef enum bt_message_type {
	BT_MESSAGE_TYPE_EVENT				= 1 << 0,
	BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY	= 1 << 1,
	BT_MESSAGE_TYPE_STREAM_BEGINNING		= 1 << 2,
	BT_MESSAGE_TYPE_STREAM_END			= 1 << 3,
	BT_MESSAGE_TYPE_PACKET_BEGINNING		= 1 << 4,
	BT_MESSAGE_TYPE_PACKET_END			= 1 << 5,
	BT_MESSAGE_TYPE_DISCARDED_EVENTS		= 1 << 6,
	BT_MESSAGE_TYPE_DISCARDED_PACKETS		= 1 << 7,
} bt_message_type;

/**
 * Get a message's type.
 *
 * @param message	Message instance
 * @returns		One of #bt_message_type
 */
extern bt_message_type bt_message_get_type(const bt_message *message);

extern void bt_message_get_ref(const bt_message *message);

extern void bt_message_put_ref(const bt_message *message);

#define BT_MESSAGE_PUT_REF_AND_RESET(_var)		\
	do {						\
		bt_message_put_ref(_var);		\
		(_var) = NULL;				\
	} while (0)

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

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE2_GRAPH_MESSAGE_CONST_H */
Commit	Line	Data
924dc299 PP	1	#ifndef BABELTRACE2_GRAPH_MESSAGE_CONST_H
924dc299 PP	2	#define BABELTRACE2_GRAPH_MESSAGE_CONST_H
90354d3a JG	3
90354d3a JG	4	/*
bbb7b5f0	5	* Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
90354d3a	6	*
90354d3a JG	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
4fa90f32 PP	26	#ifndef __BT_IN_BABELTRACE_H
	27	# error "Please include <babeltrace2/babeltrace.h> instead."
	28	#endif
	29
3fadfbc0	30	#include <babeltrace2/types.h>
b19ff26f	31
90354d3a JG	32	#ifdef __cplusplus
	33	extern "C" {
	34	#endif
	35
611c29fb	36	/**
d6e69534	37	* Message types. Unhandled message types should be ignored.
611c29fb	38	*/
4cdfc5e8	39	typedef enum bt_message_type {
9c3869a9 PP	40	BT_MESSAGE_TYPE_EVENT = 1 << 0,
	41	BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY = 1 << 1,
	42	BT_MESSAGE_TYPE_STREAM_BEGINNING = 1 << 2,
	43	BT_MESSAGE_TYPE_STREAM_END = 1 << 3,
	44	BT_MESSAGE_TYPE_PACKET_BEGINNING = 1 << 4,
	45	BT_MESSAGE_TYPE_PACKET_END = 1 << 5,
	46	BT_MESSAGE_TYPE_DISCARDED_EVENTS = 1 << 6,
	47	BT_MESSAGE_TYPE_DISCARDED_PACKETS = 1 << 7,
4cdfc5e8	48	} bt_message_type;
90354d3a	49
611c29fb	50	/**
d6e69534	51	* Get a message's type.
611c29fb	52	*
d6e69534 PP	53	* @param message Message instance
d6e69534 PP	54	* @returns One of #bt_message_type
611c29fb	55	*/
4cdfc5e8	56	extern bt_message_type bt_message_get_type(const bt_message *message);
90354d3a	57
d6e69534	58	extern void bt_message_get_ref(const bt_message *message);
c5b9b441	59
d6e69534	60	extern void bt_message_put_ref(const bt_message *message);
c5b9b441	61
d6e69534	62	#define BT_MESSAGE_PUT_REF_AND_RESET(_var) \
c5b9b441	63	do { \
d6e69534	64	bt_message_put_ref(_var); \
c5b9b441 PP	65	(_var) = NULL; \
	66	} while (0)
	67
d6e69534	68	#define BT_MESSAGE_MOVE_REF(_var_dst, _var_src) \
c5b9b441	69	do { \
d6e69534	70	bt_message_put_ref(_var_dst); \
c5b9b441 PP	71	(_var_dst) = (_var_src); \
	72	(_var_src) = NULL; \
	73	} while (0)
	74
90354d3a JG	75	#ifdef __cplusplus
	76	}
	77	#endif
	78
924dc299	79	#endif /* BABELTRACE2_GRAPH_MESSAGE_CONST_H */