[babeltrace.git] / include / babeltrace / plugin / notification / iterator.h

#ifndef BABELTRACE_PLUGIN_NOTIFICATION_ITERATOR_H
#define BABELTRACE_PLUGIN_NOTIFICATION_ITERATOR_H

/*
 * BabelTrace - Plug-in Notification Iterator
 *
 * Copyright 2015 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.
 */

#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

struct bt_notification;
struct bt_notification_iterator;

/**
 * Status code. Errors are always negative.
 */
enum bt_notification_iterator_status {
	/** No more notifications to be delivered. */
	BT_NOTIFICATION_ITERATOR_STATUS_END = 1,
	/** No error, okay. */
	BT_NOTIFICATION_ITERATOR_STATUS_OK = 0,
	/** Invalid arguments. */
	BT_NOTIFICATION_ITERATOR_STATUS_INVAL = -1,
	/** General error. */
	BT_NOTIFICATION_ITERATOR_STATUS_ERROR = -2,
	/** Out of memory. */
	BT_NOTIFICATION_ITERATOR_STATUS_NOMEM = -3,
	/** Unsupported iterator feature. */
	BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED = -4,

};

/**
 * Notification iterator seek reference.
 */
enum bt_notification_iterator_seek_origin {
	/** Seek at a time relative to the beginning of the trace. */
	BT_NOTIFICATION_ITERATOR_SEEK_ORIGIN_BEGIN = 0,

	/** Seek at a time relative to the current position. */
	BT_NOTIFICATION_ITERATOR_SEEK_ORIGIN_CURRENT = 1,

	/** Seek at a time relative to the end of the trace. */
	BT_NOTIFICATION_ITERATOR_SEEK_ORIGIN_END = 2,

	/** Seek at a time relative to EPOCH. */
	BT_NOTIFICATION_ITERATOR_SEEK_ORIGIN_EPOCH = 3,
};

/**
 * Get current notification at iterator's position.
 *
 * This functions will <b>not</b> advance the cursor's position.
 * The returned notification's reference count is already incremented.
 *
 * @param iterator	Iterator instance
 * @returns		Returns a bt_notification instance
 *
 * @see bt_put()
 */
extern struct bt_notification *bt_notification_iterator_get_notification(
		struct bt_notification_iterator *iterator);

/**
 * Advance the iterator's position forward.
 *
 * This function can be called repeatedly to iterate through the iterator's
 * associated trace.
 *
 * @param iterator	Iterator instance
 * @returns		Returns a bt_notification instance
 *
 * @see bt_notification_iterator_get_notification()
 */
extern enum bt_notification_iterator_status
bt_notification_iterator_next(struct bt_notification_iterator *iterator);

/**
 * Seek iterator to time.
 *
 * Sets the iterator's position for the trace associated with the iterator.
 * The new position is computed by adding \p time to the position specified
 * by \p seek_origin.
 *
 * time is expressed in nanoseconds.
 *
 * @param iterator	Iterator instance
 * @param seek_origin	One of #bt_notification_iterator_seek_type values.
 * @returns		One of #bt_notification_iterator_status values;
 *			if \iterator does not support seeking,
 *			#BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED is
 *			returned.
 *
 * @see bt_notification_iterator_get_notification()
 */
extern enum bt_notification_iterator_status bt_notification_iterator_seek_time(
		struct bt_notification_iterator *iterator,
		enum bt_notification_iterator_seek_origin seek_origin,
		int64_t time);

extern struct bt_component *bt_notification_iterator_get_component(
		struct bt_notification_iterator *iterator);

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_PLUGIN_NOTIFICATION_ITERATOR_H */
Commit	Line	Data
90354d3a JG	1	#ifndef BABELTRACE_PLUGIN_NOTIFICATION_ITERATOR_H
	2	#define BABELTRACE_PLUGIN_NOTIFICATION_ITERATOR_H
	3
	4	/*
	5	* BabelTrace - Plug-in Notification Iterator
	6	*
	7	* Copyright 2015 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	#include <stdint.h>
	31
	32	#ifdef __cplusplus
	33	extern "C" {
	34	#endif
	35
	36	struct bt_notification;
	37	struct bt_notification_iterator;
	38
1d7b7871 JG	39	/**
	40	* Status code. Errors are always negative.
	41	*/
	42	enum bt_notification_iterator_status {
663618ee JG	43	/** No more notifications to be delivered. */
663618ee JG	44	BT_NOTIFICATION_ITERATOR_STATUS_END = 1,
d01e0f33 JG	45	/** No error, okay. */
d01e0f33 JG	46	BT_NOTIFICATION_ITERATOR_STATUS_OK = 0,
1d7b7871	47	/** Invalid arguments. */
d01e0f33	48	BT_NOTIFICATION_ITERATOR_STATUS_INVAL = -1,
1d7b7871 JG	49	/** General error. */
1d7b7871 JG	50	BT_NOTIFICATION_ITERATOR_STATUS_ERROR = -2,
5b29e799 JG	51	/** Out of memory. */
5b29e799 JG	52	BT_NOTIFICATION_ITERATOR_STATUS_NOMEM = -3,
1d7b7871	53	/** Unsupported iterator feature. */
5b29e799	54	BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED = -4,
1d7b7871	55
1d7b7871 JG	56	};
1d7b7871 JG	57
c602a809 JG	58	/**
	59	* Notification iterator seek reference.
	60	*/
9531634f	61	enum bt_notification_iterator_seek_origin {
1d7b7871	62	/** Seek at a time relative to the beginning of the trace. */
9531634f	63	BT_NOTIFICATION_ITERATOR_SEEK_ORIGIN_BEGIN = 0,
1d7b7871	64
c602a809	65	/** Seek at a time relative to the current position. */
9531634f	66	BT_NOTIFICATION_ITERATOR_SEEK_ORIGIN_CURRENT = 1,
90354d3a	67
c602a809	68	/** Seek at a time relative to the end of the trace. */
9531634f JG	69	BT_NOTIFICATION_ITERATOR_SEEK_ORIGIN_END = 2,
	70
	71	/** Seek at a time relative to EPOCH. */
	72	BT_NOTIFICATION_ITERATOR_SEEK_ORIGIN_EPOCH = 3,
1d7b7871 JG	73	};
	74
	75	/**
	76	* Get current notification at iterator's position.
	77	*
	78	* This functions will <b>not</b> advance the cursor's position.
	79	* The returned notification's reference count is already incremented.
	80	*
9900dfa7	81	* @param iterator Iterator instance
1d7b7871 JG	82	* @returns Returns a bt_notification instance
1d7b7871 JG	83	*
448143d9	84	* @see bt_put()
1d7b7871	85	*/
0db5ca2c	86	extern struct bt_notification *bt_notification_iterator_get_notification(
90354d3a JG	87	struct bt_notification_iterator *iterator);
90354d3a JG	88
1d7b7871 JG	89	/**
	90	* Advance the iterator's position forward.
	91	*
	92	* This function can be called repeatedly to iterate through the iterator's
	93	* associated trace.
	94	*
	95	* @param iterator Iterator instance
	96	* @returns Returns a bt_notification instance
	97	*
	98	* @see bt_notification_iterator_get_notification()
	99	*/
	100	extern enum bt_notification_iterator_status
	101	bt_notification_iterator_next(struct bt_notification_iterator *iterator);
	102
	103	/**
9531634f	104	* Seek iterator to time.
1d7b7871 JG	105	*
	106	* Sets the iterator's position for the trace associated with the iterator.
	107	* The new position is computed by adding \p time to the position specified
9531634f JG	108	* by \p seek_origin.
	109	*
	110	* time is expressed in nanoseconds.
1d7b7871 JG	111	*
1d7b7871 JG	112	* @param iterator Iterator instance
9531634f	113	* @param seek_origin One of #bt_notification_iterator_seek_type values.
1d7b7871 JG	114	* @returns One of #bt_notification_iterator_status values;
	115	* if \iterator does not support seeking,
	116	* #BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED is
	117	* returned.
	118	*
	119	* @see bt_notification_iterator_get_notification()
	120	*/
9531634f JG	121	extern enum bt_notification_iterator_status bt_notification_iterator_seek_time(
	122	struct bt_notification_iterator *iterator,
	123	enum bt_notification_iterator_seek_origin seek_origin,
1d7b7871	124	int64_t time);
90354d3a	125
413bc2c4 JG	126	extern struct bt_component *bt_notification_iterator_get_component(
	127	struct bt_notification_iterator *iterator);
	128
90354d3a JG	129	#ifdef __cplusplus
	130	}
	131	#endif
	132
b5c2631a	133	#endif /* BABELTRACE_PLUGIN_NOTIFICATION_ITERATOR_H */