Rename bt_notification_packet_start to "begin"

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

diff --git a/include/babeltrace/plugin/notification/notification.h b/include/babeltrace/plugin/notification/notification.h
index 2d73dcc1a79c8fe9d8e5189dfb1b1e411c9a0303..34a185a01f11a167226a3b2b25ea90b6dc08a699 100644 (file)
--- a/include/babeltrace/plugin/notification/notification.h
+++ b/include/babeltrace/plugin/notification/notification.h
@@ -27,24 +27,59 @@
  * SOFTWARE.
  */
 
-#include <stdint.h>
-
 #ifdef __cplusplus
 extern "C" {
 #endif
 
 struct bt_notification;
 
-enum bt_plugin_notification_type {
-       BT_PLUGIN_NOTIFICATION_TYPE_UNKNOWN = -1,
-       BT_PLUGIN_NOTIFICATION_TYPE_EVENT = 0, /* see notification/event.h */
-};
+/**
+ * Notification types. Unhandled notification types should be ignored.
+ */
+enum bt_notification_type {
+       BT_NOTIFICATION_TYPE_UNKNOWN = -1,
+
+       /**
+        * All types of notifications (used to register to notification
+        * delivery).
+        */
+       BT_NOTIFICATION_TYPE_ALL = 0,
+
+       /** Event delivery notification, see event.h */
+       BT_NOTIFICATION_TYPE_EVENT = 1,
+
+       /** Beginning of stream packet notification, see packet.h */
+       BT_NOTIFICATION_TYPE_PACKET_BEGIN = 2,
+
+       /** End of stream packet notification, see packet.h */
+       BT_NOTIFICATION_TYPE_PACKET_END = 3,
+
+       /** End of stream packet notification, see stream.h */
+       BT_NOTIFICATION_TYPE_STREAM_END = 4,
 
-enum bt_plugin_notification_type bt_plugin_notification_get_type(
-               struct bt_plugin_notification *notification);
+       /** New trace notification, see model.h */
+       BT_NOTIFICATION_TYPE_NEW_TRACE = 5,
 
-void bt_plugin_notification_get(struct bt_plugin_notification *notification);
-void bt_plugin_notification_put(struct bt_plugin_notification *notification);
+       /** New stream class notification, see model.h */
+       BT_NOTIFICATION_TYPE_NEW_STREAM_CLASS = 6,
+
+       /** New event class notification, see model.h */
+       BT_NOTIFICATION_TYPE_NEW_EVENT_CLASS = 7,
+
+       /** End of trace notification, see eot.h */
+       BT_NOTIFICATION_TYPE_END_OF_TRACE = 8,
+
+       BT_NOTIFICATION_TYPE_NR, /* Not part of ABI. */
+};
+
+/**
+ * Get a notification's type.
+ *
+ * @param notification Notification instance
+ * @returns            One of #bt_notification_type
+ */
+extern enum bt_notification_type bt_notification_get_type(
+               struct bt_notification *notification);
 
 #ifdef __cplusplus
 }