fix/breakage API : replace bt_ctf_event

[babeltrace.git] / include / babeltrace / ctf / iterator.h

diff --git a/include/babeltrace/ctf/iterator.h b/include/babeltrace/ctf/iterator.h
index 8f9af0e19e3b8af855f2e3fae71200014b8af16c..7aeb032c81f23e506edcb9392b7574f85e0152f5 100644 (file)
--- a/include/babeltrace/ctf/iterator.h
+++ b/include/babeltrace/ctf/iterator.h
@@ -26,7 +26,7 @@
 #include <babeltrace/iterator.h>
 
 struct bt_ctf_iter;
-struct bt_ctf_event;
+struct ctf_event_definition;
 
 /*
  * bt_ctf_iter_create - Allocate a CTF trace collection iterator.
@@ -39,10 +39,17 @@ 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,
-               struct bt_iter_pos *begin_pos,
-               struct bt_iter_pos *end_pos);
+               const struct bt_iter_pos *begin_pos,
+               const struct bt_iter_pos *end_pos);
 
 /*
  * bt_ctf_get_iter - get iterator from ctf iterator.
@@ -61,6 +68,6 @@ void bt_ctf_iter_destroy(struct bt_ctf_iter *iter);
  *
  * Return current event on success, NULL on end of trace.
  */
-struct bt_ctf_event *bt_ctf_iter_read_event(struct bt_ctf_iter *iter);
+struct ctf_event_definition *bt_ctf_iter_read_event(struct bt_ctf_iter *iter);
 
 #endif /* _BABELTRACE_CTF_ITERATOR_H */