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

#ifndef BABELTRACE_GRAPH_NOTIFICATION_PACKET_H
#define BABELTRACE_GRAPH_NOTIFICATION_PACKET_H

/*
 * BabelTrace - Plug-in Packet-related Notifications
 *
 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * Author: 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_object_get_ref() */
#include <babeltrace/object.h>

#ifdef __cplusplus
extern "C" {
#endif

struct bt_notification;
struct bt_private_connection_private_notification_iterator;
struct bt_packet;

extern
struct bt_notification *bt_notification_packet_begin_create(
		struct bt_private_connection_private_notification_iterator *notification_iterator,
		struct bt_packet *packet);

extern
struct bt_notification *bt_notification_packet_end_create(
		struct bt_private_connection_private_notification_iterator *notification_iterator,
		struct bt_packet *packet);


extern struct bt_packet *bt_notification_packet_begin_borrow_packet(
		struct bt_notification *notification);

static inline
struct bt_packet *bt_notification_packet_begin_get_packet(
		struct bt_notification *notification)
{
	return bt_object_get_ref(bt_notification_packet_begin_borrow_packet(notification));
}

extern struct bt_packet *bt_notification_packet_end_borrow_packet(
		struct bt_notification *notification);

static inline
struct bt_packet *bt_notification_packet_end_get_packet(
		struct bt_notification *notification)
{
	return bt_object_get_ref(bt_notification_packet_end_borrow_packet(notification));
}

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_GRAPH_NOTIFICATION_PACKET_H */
Commit	Line	Data
	1	#ifndef BABELTRACE_GRAPH_NOTIFICATION_PACKET_H
	2	#define BABELTRACE_GRAPH_NOTIFICATION_PACKET_H
	3
	4	/*
	5	* BabelTrace - Plug-in Packet-related Notifications
	6	*
	7	* Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	8	*
	9	* Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
	10	*
	11	* Permission is hereby granted, free of charge, to any person obtaining a copy
	12	* of this software and associated documentation files (the "Software"), to deal
	13	* in the Software without restriction, including without limitation the rights
	14	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	15	* copies of the Software, and to permit persons to whom the Software is
	16	* furnished to do so, subject to the following conditions:
	17	*
	18	* The above copyright notice and this permission notice shall be included in
	19	* all copies or substantial portions of the Software.
	20	*
	21	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	22	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	23	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	24	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	25	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	26	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	27	* SOFTWARE.
	28	*/
	29
	30	/* For bt_object_get_ref() */
	31	#include <babeltrace/object.h>
	32
	33	#ifdef __cplusplus
	34	extern "C" {
	35	#endif
	36
	37	struct bt_notification;
	38	struct bt_private_connection_private_notification_iterator;
	39	struct bt_packet;
	40
	41	extern
	42	struct bt_notification *bt_notification_packet_begin_create(
	43	struct bt_private_connection_private_notification_iterator *notification_iterator,
	44	struct bt_packet *packet);
	45
	46	extern
	47	struct bt_notification *bt_notification_packet_end_create(
	48	struct bt_private_connection_private_notification_iterator *notification_iterator,
	49	struct bt_packet *packet);
	50
	51
	52	extern struct bt_packet *bt_notification_packet_begin_borrow_packet(
	53	struct bt_notification *notification);
	54
	55	static inline
	56	struct bt_packet *bt_notification_packet_begin_get_packet(
	57	struct bt_notification *notification)
	58	{
	59	return bt_object_get_ref(bt_notification_packet_begin_borrow_packet(notification));
	60	}
	61
	62	extern struct bt_packet *bt_notification_packet_end_borrow_packet(
	63	struct bt_notification *notification);
	64
	65	static inline
	66	struct bt_packet *bt_notification_packet_end_get_packet(
	67	struct bt_notification *notification)
	68	{
	69	return bt_object_get_ref(bt_notification_packet_end_borrow_packet(notification));
	70	}
	71
	72	#ifdef __cplusplus
	73	}
	74	#endif
	75
	76	#endif /* BABELTRACE_GRAPH_NOTIFICATION_PACKET_H */