[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 error, okay. */
	BT_NOTIFICATION_ITERATOR_STATUS_OK = 0,
	/** Invalid arguments. */
	BT_NOTIFICATION_ITERATOR_STATUS_INVAL = -1,
	/** General error. */
	BT_NOTIFICATION_ITERATOR_STATUS_ERROR = -2,
	/** Unsupported iterator feature. */
	BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED = -3,

};

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

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

	/** Seek at a time relative to the end of the trace. */
	BT_NOTIFICATION_ITERATOR_SEEK_TYPE_END = 1,
};

/**
 * 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 position.
 *
 * 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 whence.
 *
 * @param iterator	Iterator instance
 * @param whence	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(
		struct bt_notification_iterator *iterator, int whence,
		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 {
d01e0f33 JG	43	/** No error, okay. */
d01e0f33 JG	44	BT_NOTIFICATION_ITERATOR_STATUS_OK = 0,
1d7b7871	45	/** Invalid arguments. */
d01e0f33	46	BT_NOTIFICATION_ITERATOR_STATUS_INVAL = -1,
1d7b7871 JG	47	/** General error. */
1d7b7871 JG	48	BT_NOTIFICATION_ITERATOR_STATUS_ERROR = -2,
1d7b7871	49	/** Unsupported iterator feature. */
d01e0f33	50	BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED = -3,
1d7b7871	51
1d7b7871 JG	52	};
1d7b7871 JG	53
c602a809 JG	54	/**
	55	* Notification iterator seek reference.
	56	*/
1d7b7871 JG	57	enum bt_notification_iterator_seek_type {
	58	/** Seek at a time relative to the beginning of the trace. */
	59	BT_NOTIFICATION_ITERATOR_SEEK_TYPE_BEGIN = 0,
	60
c602a809	61	/** Seek at a time relative to the current position. */
1d7b7871	62	BT_NOTIFICATION_ITERATOR_SEEK_TYPE_CURRENT = 1,
90354d3a	63
c602a809 JG	64	/** Seek at a time relative to the end of the trace. */
c602a809 JG	65	BT_NOTIFICATION_ITERATOR_SEEK_TYPE_END = 1,
1d7b7871 JG	66	};
	67
	68	/**
	69	* Get current notification at iterator's position.
	70	*
	71	* This functions will <b>not</b> advance the cursor's position.
	72	* The returned notification's reference count is already incremented.
	73	*
9900dfa7	74	* @param iterator Iterator instance
1d7b7871 JG	75	* @returns Returns a bt_notification instance
1d7b7871 JG	76	*
448143d9	77	* @see bt_put()
1d7b7871	78	*/
0db5ca2c	79	extern struct bt_notification *bt_notification_iterator_get_notification(
90354d3a JG	80	struct bt_notification_iterator *iterator);
90354d3a JG	81
1d7b7871 JG	82	/**
	83	* Advance the iterator's position forward.
	84	*
	85	* This function can be called repeatedly to iterate through the iterator's
	86	* associated trace.
	87	*
	88	* @param iterator Iterator instance
	89	* @returns Returns a bt_notification instance
	90	*
	91	* @see bt_notification_iterator_get_notification()
	92	*/
	93	extern enum bt_notification_iterator_status
	94	bt_notification_iterator_next(struct bt_notification_iterator *iterator);
	95
	96	/**
	97	* Seek iterator to position.
	98	*
	99	* Sets the iterator's position for the trace associated with the iterator.
	100	* The new position is computed by adding \p time to the position specified
	101	* by \p whence.
	102	*
	103	* @param iterator Iterator instance
	104	* @param whence One of #bt_notification_iterator_seek_type values.
	105	* @returns One of #bt_notification_iterator_status values;
	106	* if \iterator does not support seeking,
	107	* #BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED is
	108	* returned.
	109	*
	110	* @see bt_notification_iterator_get_notification()
	111	*/
	112	extern enum bt_notification_iterator_status *bt_notification_iterator_seek(
8738a040	113	struct bt_notification_iterator *iterator, int whence,
1d7b7871	114	int64_t time);
90354d3a	115
413bc2c4 JG	116	extern struct bt_component *bt_notification_iterator_get_component(
	117	struct bt_notification_iterator *iterator);
	118
90354d3a JG	119	#ifdef __cplusplus
	120	}
	121	#endif
	122
b5c2631a	123	#endif /* BABELTRACE_PLUGIN_NOTIFICATION_ITERATOR_H */