#include <babeltrace/iterator.h>
+#ifdef __cplusplus
+extern "C" {
+#endif
+
struct bt_ctf_iter;
struct bt_ctf_event;
* 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.
+ *
+ * Return a pointer to the newly allocated iterator.
+ *
+ * Only one iterator can be created against a context. If more than one
+ * iterator is being created for the same context, the second creation
+ * will return NULL. The previous iterator must be destroyed before
+ * creation of the new iterator for this function to succeed.
*/
struct bt_ctf_iter *bt_ctf_iter_create(struct bt_context *ctx,
const struct bt_iter_pos *begin_pos,
/*
* bt_ctf_iter_read_event: Read the iterator's current event data.
*
- * @iter: trace collection iterator (input)
+ * @iter: trace collection iterator (input). Should NOT be NULL.
*
* Return current event on success, NULL on end of trace.
*/
struct bt_ctf_event *bt_ctf_iter_read_event(struct bt_ctf_iter *iter);
+#ifdef __cplusplus
+}
+#endif
+
#endif /* _BABELTRACE_CTF_ITERATOR_H */