Init ctf fs data and metadata streams

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

diff --git a/include/babeltrace/plugin/notification/iterator.h b/include/babeltrace/plugin/notification/iterator.h
index 51247d182ce50810d15a08ce84f4b7d4afbd8d8e..5558aa7f74c2dbde62831649b7f42222e601ba13 100644 (file)
--- a/include/babeltrace/plugin/notification/iterator.h
+++ b/include/babeltrace/plugin/notification/iterator.h
@@ -42,7 +42,7 @@ struct bt_notification_iterator;
 enum bt_notification_iterator_status {
        /** Invalid arguments. */
        /* -22 for compatibility with -EINVAL */
-       BT_NOTIFICATION_ITERATOR_STATUS_EINVAL = -22,
+       BT_NOTIFICATION_ITERATOR_STATUS_INVAL = -22,
 
        /** End of trace. */
        BT_NOTIFICATION_ITERATOR_STATUS_EOT = -3,
@@ -57,15 +57,18 @@ enum bt_notification_iterator_status {
        BT_NOTIFICATION_ITERATOR_STATUS_OK = 0,
 };
 
+/**
+ * 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 */
+       /** Seek at a time relative to the current position. */
        BT_NOTIFICATION_ITERATOR_SEEK_TYPE_CURRENT = 1,
 
-       /** Seek at a absolute time */
-       BT_NOTIFICATION_ITERATOR_SEEK_TYPE_SET = 2,
+       /** Seek at a time relative to the end of the trace. */
+       BT_NOTIFICATION_ITERATOR_SEEK_TYPE_END = 1,
 };
 
 /**
@@ -74,10 +77,10 @@ enum bt_notification_iterator_seek_type {
  * This functions will <b>not</b> advance the cursor's position.
  * The returned notification's reference count is already incremented.
  *
- * @param Iterator     Iterator instance
+ * @param iterator     Iterator instance
  * @returns            Returns a bt_notification instance
  *
- * @see bt_notification_put()
+ * @see bt_put()
  */
 extern struct bt_notification *bt_notification_iterator_get_notification(
                struct bt_notification_iterator *iterator);
@@ -113,29 +116,10 @@ bt_notification_iterator_next(struct bt_notification_iterator *iterator);
  * @see bt_notification_iterator_get_notification()
  */
 extern enum bt_notification_iterator_status *bt_notification_iterator_seek(
-               struct bt_notification_iterator *iterator,
-               int whence,
+               struct bt_notification_iterator *iterator, int whence,
                int64_t time);
 
-/**
- * Increments the reference count of \p iterator.
- *
- * @param iterator     Iterator of which to increment the reference count
- *
- * @see bt_notification_iterator_put()
- */
-extern void bt_notification_iterator_get(
-               struct bt_notification_iterator *iterator);
-
-/**
- * Decrements the reference count of \p iterator, destroying it when this
- * count reaches 0.
- *
- * @param iterator     Iterator of which to decrement the reference count
- *
- * @see bt_notification_iterator_get()
- */
-extern void bt_notification_iterator_put(
+extern struct bt_component *bt_notification_iterator_get_component(
                struct bt_notification_iterator *iterator);
 
 #ifdef __cplusplus