lib: add aliases for Babeltrace structure types

[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 35f68a8398d805950f5732b3d86fb32cd5366e9e..bd58398cf61d90672448182420cd47c550e80c08 100644 (file)
--- a/include/babeltrace/graph/notification-iterator.h
+++ b/include/babeltrace/graph/notification-iterator.h
@@ -2,12 +2,9 @@
 #define BABELTRACE_GRAPH_NOTIFICATION_ITERATOR_H
 
 /*
- * BabelTrace - Plug-in Notification Iterator
- *
+ * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
  * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
- * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
- *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
  * in the Software without restriction, including without limitation the rights
@@ -27,111 +24,22 @@
  * SOFTWARE.
  */
 
-#include <stdint.h>
+/* For bt_notification, bt_notification_iterator */
+#include <babeltrace/types.h>
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-struct bt_notification;
-struct bt_notification_iterator;
-
-/**
- * Status code. Errors are always negative.
- */
 enum bt_notification_iterator_status {
-       /** 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,
-       /** No error, okay. */
        BT_NOTIFICATION_ITERATOR_STATUS_OK = 0,
-       /** Invalid arguments. */
-       BT_NOTIFICATION_ITERATOR_STATUS_INVALID = -22,
-       /** General error. */
+       BT_NOTIFICATION_ITERATOR_STATUS_END = 1,
+       BT_NOTIFICATION_ITERATOR_STATUS_AGAIN = 11,
+       BT_NOTIFICATION_ITERATOR_STATUS_CANCELED = 125,
        BT_NOTIFICATION_ITERATOR_STATUS_ERROR = -1,
-       /** Out of memory. */
        BT_NOTIFICATION_ITERATOR_STATUS_NOMEM = -12,
-       /** Unsupported iterator feature. */
-       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.
- *
- * This functions will <b>not</b> advance the cursor's position.
- * The returned notification's reference count is already incremented.
- *
- * @param iterator     Iterator instance
- * @returns            Returns a bt_notification instance
- *
- * @see bt_put()
- */
-extern struct bt_notification *bt_notification_iterator_get_notification(
-               struct bt_notification_iterator *iterator);
-
-/**
- * Advance the iterator's position forward.
- *
- * This function can be called repeatedly to iterate through the iterator's
- * associated trace.
- *
- * @param iterator     Iterator instance
- * @returns            Returns a bt_notification instance
- *
- * @see 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