From c54983704d35cb1cd6da38cb087df2e3b5cfd5d0 Mon Sep 17 00:00:00 2001 From: Mathieu Desnoyers Date: Thu, 8 Mar 2012 17:26:13 -0500 Subject: [PATCH] Add missing iterator.h into the git repo Signed-off-by: Mathieu Desnoyers --- include/babeltrace/ctf/iterator.h | 67 +++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 include/babeltrace/ctf/iterator.h diff --git a/include/babeltrace/ctf/iterator.h b/include/babeltrace/ctf/iterator.h new file mode 100644 index 00000000..564b6e23 --- /dev/null +++ b/include/babeltrace/ctf/iterator.h @@ -0,0 +1,67 @@ +#ifndef _BABELTRACE_CTF_ITERATOR_H +#define _BABELTRACE_CTF_ITERATOR_H + +/* + * BabelTrace + * + * CTF iterator API + * + * Copyright 2011-2012 EfficiOS Inc. and Linux Foundation + * + * Author: Mathieu Desnoyers + * Julien Desfossez + * + * 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. + */ + +#include + +struct bt_ctf_iter; +struct bt_ctf_event; + +/* + * bt_ctf_iter_create - Allocate a CTF trace collection iterator. + * + * begin_pos and end_pos are optional parameters to specify the position + * at which the trace collection should be seeked upon iterator + * creation, and the position at which iteration will start returning + * "EOF". + * + * By default, if begin_pos is NULL, a BT_SEEK_CUR is performed at + * creation. By default, if end_pos is NULL, a BT_SEEK_END (end of + * trace) is the EOF criterion. + */ +struct bt_ctf_iter *bt_ctf_iter_create(struct bt_context *ctx, + struct bt_iter_pos *begin_pos, + struct bt_iter_pos *end_pos); + +/* + * bt_ctf_get_iter - get iterator from ctf iterator. + */ +struct bt_iter *bt_ctf_get_iter(struct bt_ctf_iter *iter); + +/* + * bt_ctf_iter_destroy - Free a CTF trace collection iterator. + */ +void bt_ctf_iter_destroy(struct bt_ctf_iter *iter); + +/* + * bt_ctf_iter_read_event: Read the iterator's current event data. + * + * @iter: trace collection iterator (input) + * @stream: stream containing event at current position (output) + * @event: current event (output) + * Return 0 on success, negative error value on error. + */ +struct bt_ctf_event *bt_ctf_iter_read_event(struct bt_ctf_iter *iter); + +#endif /* _BABELTRACE_CTF_ITERATOR_H */ -- 2.34.1