Remove notification iterator seeking API until it's supported

[deliverable/babeltrace.git] / include / babeltrace / graph / notification-iterator.h

diff --git a/include/babeltrace/graph/notification-iterator.h b/include/babeltrace/graph/notification-iterator.h
index 753ff6ec2aaf5fad8fe4fc4a04ee538030b79744..29d787a9c42ca2011fb76517c9382d5fc69cf85d 100644 (file)
--- a/include/babeltrace/graph/notification-iterator.h
+++ b/include/babeltrace/graph/notification-iterator.h
@@ -2,7 +2,7 @@
 #define BABELTRACE_GRAPH_NOTIFICATION_ITERATOR_H
 
 /*
- * BabelTrace - Plug-in Notification Iterator
+ * BabelTrace - Notification Iterator
  *
  * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
@@ -40,7 +40,9 @@ struct bt_notification_iterator;
  * Status code. Errors are always negative.
  */
 enum bt_notification_iterator_status {
-       /** Try again. */
+       /** Canceled. */
+       BT_NOTIFICATION_ITERATOR_STATUS_CANCELED = 125,
+       /** No notifications available for now. Try again later. */
        BT_NOTIFICATION_ITERATOR_STATUS_AGAIN = 11,
        /** No more notifications to be delivered. */
        BT_NOTIFICATION_ITERATOR_STATUS_END = 1,
@@ -56,28 +58,6 @@ enum bt_notification_iterator_status {
        BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED = -2,
 };
 
-/**
- * Notification iterator seek reference.
- */
-enum bt_notification_iterator_seek_origin {
-       /** Seek at a time relative to the beginning of the trace. */
-       BT_NOTIFICATION_ITERATOR_SEEK_ORIGIN_BEGIN = 0,
-
-       /** Seek at a time relative to the current position. */
-       BT_NOTIFICATION_ITERATOR_SEEK_ORIGIN_CURRENT = 1,
-
-       /** Seek at a time relative to the end of the trace. */
-       BT_NOTIFICATION_ITERATOR_SEEK_ORIGIN_END = 2,
-
-       /** Seek at a time relative to EPOCH. */
-       BT_NOTIFICATION_ITERATOR_SEEK_ORIGIN_EPOCH = 3,
-};
-
-struct bt_notification_iterator_next_return {
-       struct bt_notification *notification;
-       enum bt_notification_iterator_status status;
-};
-
 /**
  * Get current notification at iterator's position.
  *
@@ -106,29 +86,6 @@ extern struct bt_notification *bt_notification_iterator_get_notification(
 extern enum bt_notification_iterator_status
 bt_notification_iterator_next(struct bt_notification_iterator *iterator);
 
-/**
- * Seek iterator to time.
- *
- * Sets the iterator's position for the trace associated with the iterator.
- * The new position is computed by adding \p time to the position specified
- * by \p seek_origin.
- *
- * time is expressed in nanoseconds.
- *
- * @param iterator     Iterator instance
- * @param seek_origin  One of #bt_notification_iterator_seek_type values.
- * @returns            One of #bt_notification_iterator_status values;
- *                     if \iterator does not support seeking,
- *                     #BT_NOTIFICATION_ITERATOR_STATUS_UNSUPPORTED is
- *                     returned.
- *
- * @see bt_notification_iterator_get_notification()
- */
-extern enum bt_notification_iterator_status bt_notification_iterator_seek_time(
-               struct bt_notification_iterator *iterator,
-               enum bt_notification_iterator_seek_origin seek_origin,
-               int64_t time);
-
 extern struct bt_component *bt_notification_iterator_get_component(
                struct bt_notification_iterator *iterator);