lib: add internal object pool API and use it; adapt plugins/tests
[babeltrace.git] / include / babeltrace / graph / notification-iterator.h
index 03b84d97762cc197871bf0f2b14fc0c9d5768159..a062f2e4d581142a8853c0feec7a36c110449a23 100644 (file)
@@ -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>
  *
@@ -27,6 +27,9 @@
  * SOFTWARE.
  */
 
+/* For bt_get() */
+#include <babeltrace/ref.h>
+
 #include <stdint.h>
 
 #ifdef __cplusplus
@@ -58,22 +61,8 @@ 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,
-};
+extern struct bt_notification *bt_notification_iterator_borrow_notification(
+               struct bt_notification_iterator *iterator);
 
 /**
  * Get current notification at iterator's position.
@@ -86,8 +75,12 @@ enum bt_notification_iterator_seek_origin {
  *
  * @see bt_put()
  */
-extern struct bt_notification *bt_notification_iterator_get_notification(
-               struct bt_notification_iterator *iterator);
+static inline
+struct bt_notification *bt_notification_iterator_get_notification(
+               struct bt_notification_iterator *iterator)
+{
+       return bt_get(bt_notification_iterator_borrow_notification(iterator));
+}
 
 /**
  * Advance the iterator's position forward.
@@ -103,32 +96,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);
-
 #ifdef __cplusplus
 }
 #endif
This page took 0.026627 seconds and 4 git commands to generate.