Notification interfaces

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

diff --git a/include/babeltrace/plugin/notification/event.h b/include/babeltrace/plugin/notification/event.h
index 93d1d68afed956d6f8c4f6c8e5a91d695ec9d640..39d3e03be1c1d0e94656ef54ac52c3b5cfab5445 100644 (file)
--- a/include/babeltrace/plugin/notification/event.h
+++ b/include/babeltrace/plugin/notification/event.h
@@ -2,7 +2,7 @@
 #define BABELTRACE_PLUGIN_NOTIFICATION_EVENT_H
 
 /*
- * BabelTrace - Plug-in Notification
+ * BabelTrace - Plug-in Event Notification
  *
  * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
@@ -27,16 +27,60 @@
  * SOFTWARE.
  */
 
-#include <stdint.h>
-
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-struct bt_notification;
+struct bt_plugin_notification;
+struct bt_ctf_trace;
+struct bt_ctf_stream;
 struct bt_ctf_event;
 
-struct bt_ctf_event *bt_plugin_notification_event_get_event(
+/**
+ * Create an event notification.
+ *
+ * @param trace                        The event's trace
+ * @param stream               The event's stream
+ * @param event                        The event
+ * @returns                    An event notification instance
+ *
+ * @see #bt_plugin_notification_type
+ */
+extern struct bt_plugin_notification *bt_plugin_notification_event_create(
+               struct bt_ctf_trace *trace, struct bt_ctf_stream *stream,
+               struct bt_ctf_event *event);
+
+/**
+ * Get an event notification's associated trace.
+ *
+ * @param notification Event notification instance
+ * @returns            A trace instance
+ *
+ * @see #bt_ctf_trace
+ */
+extern struct bt_ctf_trace *bt_plugin_notification_event_get_trace(
+               struct bt_plugin_notification *notification);
+
+/**
+ * Get an event notification's associated stream.
+ *
+ * @param notification Event notification instance
+ * @returns            A stream instance
+ *
+ * @see #bt_ctf_stream
+ */
+extern struct bt_ctf_stream *bt_plugin_notification_event_get_stream(
+               struct bt_plugin_notification *notification);
+
+/**
+ * Get an event notification's event.
+ *
+ * @param notification Event notification instance
+ * @returns            An event instance
+ *
+ * @see #bt_ctf_event
+ */
+extern struct bt_ctf_event *bt_plugin_notification_event_get_event(
                struct bt_plugin_notification *notification);
 
 #ifdef __cplusplus