[babeltrace.git] / include / babeltrace / graph / notification-const.h

#ifndef BABELTRACE_GRAPH_NOTIFICATION_CONST_H
#define BABELTRACE_GRAPH_NOTIFICATION_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_notification */
#include <babeltrace/types.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
 * Notification types. Unhandled notification types should be ignored.
 */
enum bt_notification_type {
	BT_NOTIFICATION_TYPE_EVENT =			0,
	BT_NOTIFICATION_TYPE_INACTIVITY =		1,
	BT_NOTIFICATION_TYPE_STREAM_BEGINNING =		2,
	BT_NOTIFICATION_TYPE_STREAM_END =		3,
	BT_NOTIFICATION_TYPE_PACKET_BEGINNING =		4,
	BT_NOTIFICATION_TYPE_PACKET_END =		5,
};

/**
 * Get a notification's type.
 *
 * @param notification	Notification instance
 * @returns		One of #bt_notification_type
 */
extern enum bt_notification_type bt_notification_get_type(
		const bt_notification *notification);

extern void bt_notification_get_ref(const bt_notification *notification);

extern void bt_notification_put_ref(const bt_notification *notification);

#define BT_NOTIFICATION_PUT_REF_AND_RESET(_var)		\
	do {						\
		bt_notification_put_ref(_var);		\
		(_var) = NULL;				\
	} while (0)

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

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_GRAPH_NOTIFICATION_CONST_H */
Commit	Line	Data
	1	#ifndef BABELTRACE_GRAPH_NOTIFICATION_CONST_H
	2	#define BABELTRACE_GRAPH_NOTIFICATION_CONST_H
	3
	4	/*
	5	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
	6	* Copyright 2015 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	/* For bt_notification */
	28	#include <babeltrace/types.h>
	29
	30	#ifdef __cplusplus
	31	extern "C" {
	32	#endif
	33
	34	/**
	35	* Notification types. Unhandled notification types should be ignored.
	36	*/
	37	enum bt_notification_type {
	38	BT_NOTIFICATION_TYPE_EVENT = 0,
	39	BT_NOTIFICATION_TYPE_INACTIVITY = 1,
	40	BT_NOTIFICATION_TYPE_STREAM_BEGINNING = 2,
	41	BT_NOTIFICATION_TYPE_STREAM_END = 3,
	42	BT_NOTIFICATION_TYPE_PACKET_BEGINNING = 4,
	43	BT_NOTIFICATION_TYPE_PACKET_END = 5,
	44	};
	45
	46	/**
	47	* Get a notification's type.
	48	*
	49	* @param notification Notification instance
	50	* @returns One of #bt_notification_type
	51	*/
	52	extern enum bt_notification_type bt_notification_get_type(
	53	const bt_notification *notification);
	54
	55	extern void bt_notification_get_ref(const bt_notification *notification);
	56
	57	extern void bt_notification_put_ref(const bt_notification *notification);
	58
	59	#define BT_NOTIFICATION_PUT_REF_AND_RESET(_var) \
	60	do { \
	61	bt_notification_put_ref(_var); \
	62	(_var) = NULL; \
	63	} while (0)
	64
	65	#define BT_NOTIFICATION_MOVE_REF(_var_dst, _var_src) \
	66	do { \
	67	bt_notification_put_ref(_var_dst); \
	68	(_var_dst) = (_var_src); \
	69	(_var_src) = NULL; \
	70	} while (0)
	71
	72	#ifdef __cplusplus
	73	}
	74	#endif
	75
	76	#endif /* BABELTRACE_GRAPH_NOTIFICATION_CONST_H */