Get rid of clock-raw and use real clock

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

diff --git a/include/babeltrace/iterator.h b/include/babeltrace/iterator.h
index 2760724291250be7a71f328af0e33c081bdd82d7..8c106ccb16cb0b76500264d8ae38b6f97a362ab3 100644 (file)
--- a/include/babeltrace/iterator.h
+++ b/include/babeltrace/iterator.h
@@ -22,10 +22,25 @@
 
 /* Forward declarations */
 struct bt_iter;
-struct ctf_stream_event;
-struct ctf_stream;
 struct bt_saved_pos;
 
+/*
+ * bt_iter is an abstract class, each format has to implement its own
+ * iterator derived from this parent class.
+ */
+
+/*
+ * bt_iter_pos
+ *
+ * This structure represents the position where to set an iterator.
+ *
+ * type represents the type of seek to use.
+ * u is the argument of the seek if necessary :
+ * - seek_time is the real timestamp to seek to when using BT_SEEK_TIME, it
+ *   is expressed in "raw" seconds (not offsetted)
+ * - restore is a position saved with bt_iter_get_pos, it is used with
+ *   BT_SEEK_RESTORE.
+ */
 struct bt_iter_pos {
        enum {
                BT_SEEK_TIME,           /* uses u.seek_time */
@@ -40,27 +55,6 @@ struct bt_iter_pos {
        } u;
 };
 
-/*
- * bt_iter_create - Allocate a 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_iter *bt_iter_create(struct bt_context *ctx,
-               struct bt_iter_pos *begin_pos,
-               struct bt_iter_pos *end_pos);
-
-/*
- * bt_iter_destroy - Free a trace collection iterator.
- */
-void bt_iter_destroy(struct bt_iter *iter);
-
 /*
  * bt_iter_next: Move trace collection position to the next event.
  *
@@ -74,8 +68,7 @@ int bt_iter_next(struct bt_iter *iter);
  * The position returned by this function needs to be freed by
  * bt_iter_free_pos after use.
  */
-struct bt_iter_pos *
-       bt_iter_get_pos(struct bt_iter *iter);
+struct bt_iter_pos *bt_iter_get_pos(struct bt_iter *iter);
 
 /*
  * bt_iter_free_pos - Free the position.
@@ -85,23 +78,25 @@ void bt_iter_free_pos(struct bt_iter_pos *pos);
 /*
  * bt_iter_set_pos: move the iterator to a given position.
  *
- * Return EOF if position is after the last event of the trace collection.
- * Return other negative value for other errors.
+ * On error, the stream_heap is reinitialized and returned empty.
+ *
  * Return 0 for success.
+ *
+ * Return EOF if the position requested is after the last event of the
+ * trace collection.
+ * Return -EINVAL when called with invalid parameter.
+ * Return -ENOMEM if the stream_heap could not be properly initialized.
  */
-int bt_iter_set_pos(struct bt_iter *iter,
-               const struct bt_iter_pos *pos);
+int bt_iter_set_pos(struct bt_iter *iter, const struct bt_iter_pos *pos);
 
 /*
- * bt_iter_read_event: Read the iterator's current event data.
+ * bt_iter_create_time_pos: create a position based on time
  *
- * @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.
+ * This function allocates and returns a new bt_iter_pos (which must be freed
+ * with bt_iter_free_pos) to be able to restore an iterator position based on a
+ * real timestamp.
  */
-int bt_iter_read_event(struct bt_iter *iter,
-               struct ctf_stream **stream,
-               struct ctf_stream_event **event);
+struct bt_iter_pos *bt_iter_create_time_pos(struct bt_iter *iter,
+               uint64_t timestamp);
 
 #endif /* _BABELTRACE_ITERATOR_H */