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

#ifndef BABELTRACE_GRAPH_MESSAGE_CONST_H
#define BABELTRACE_GRAPH_MESSAGE_CONST_H

/*
 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
 * Copyright 2015 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.
 */

/* For bt_message */
#include <babeltrace/types.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
 * Message types. Unhandled message types should be ignored.
 */
typedef enum bt_message_type {
	BT_MESSAGE_TYPE_EVENT = 0,
	BT_MESSAGE_TYPE_INACTIVITY = 1,
	BT_MESSAGE_TYPE_STREAM_BEGINNING = 2,
	BT_MESSAGE_TYPE_STREAM_END = 3,
	BT_MESSAGE_TYPE_PACKET_BEGINNING = 4,
	BT_MESSAGE_TYPE_PACKET_END = 5,
	BT_MESSAGE_TYPE_STREAM_ACTIVITY_BEGINNING = 6,
	BT_MESSAGE_TYPE_STREAM_ACTIVITY_END = 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 /* BABELTRACE_GRAPH_MESSAGE_CONST_H */
Commit	Line	Data
c14831f0 PP	1	#ifndef BABELTRACE_GRAPH_MESSAGE_CONST_H
c14831f0 PP	2	#define BABELTRACE_GRAPH_MESSAGE_CONST_H
90354d3a JG	3
90354d3a JG	4	/*
0554db57	5	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
90354d3a JG	6	* Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
90354d3a JG	7	*
90354d3a JG	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
c14831f0	27	/* For bt_message */
b9879703 PP	28	#include <babeltrace/types.h>
b9879703 PP	29
90354d3a JG	30	#ifdef __cplusplus
	31	extern "C" {
	32	#endif
	33
611c29fb	34	/**
c14831f0	35	* Message types. Unhandled message types should be ignored.
611c29fb	36	*/
b7c5b62e	37	typedef enum bt_message_type {
2accc83a PP	38	BT_MESSAGE_TYPE_EVENT = 0,
	39	BT_MESSAGE_TYPE_INACTIVITY = 1,
	40	BT_MESSAGE_TYPE_STREAM_BEGINNING = 2,
	41	BT_MESSAGE_TYPE_STREAM_END = 3,
	42	BT_MESSAGE_TYPE_PACKET_BEGINNING = 4,
	43	BT_MESSAGE_TYPE_PACKET_END = 5,
	44	BT_MESSAGE_TYPE_STREAM_ACTIVITY_BEGINNING = 6,
	45	BT_MESSAGE_TYPE_STREAM_ACTIVITY_END = 7,
b7c5b62e	46	} bt_message_type;
90354d3a	47
611c29fb	48	/**
c14831f0	49	* Get a message's type.
611c29fb	50	*
c14831f0 PP	51	* @param message Message instance
c14831f0 PP	52	* @returns One of #bt_message_type
611c29fb	53	*/
b7c5b62e	54	extern bt_message_type bt_message_get_type(const bt_message *message);
90354d3a	55
c14831f0	56	extern void bt_message_get_ref(const bt_message *message);
317e35ec	57
c14831f0	58	extern void bt_message_put_ref(const bt_message *message);
317e35ec	59
c14831f0	60	#define BT_MESSAGE_PUT_REF_AND_RESET(_var) \
317e35ec	61	do { \
c14831f0	62	bt_message_put_ref(_var); \
317e35ec PP	63	(_var) = NULL; \
	64	} while (0)
	65
c14831f0	66	#define BT_MESSAGE_MOVE_REF(_var_dst, _var_src) \
317e35ec	67	do { \
c14831f0	68	bt_message_put_ref(_var_dst); \
317e35ec PP	69	(_var_dst) = (_var_src); \
	70	(_var_src) = NULL; \
	71	} while (0)
	72
90354d3a JG	73	#ifdef __cplusplus
	74	}
	75	#endif
	76
c14831f0	77	#endif /* BABELTRACE_GRAPH_MESSAGE_CONST_H */