notification: add trigger accessor to lttng_notification

[lttng-tools.git] / include / lttng / notification / notification.h

diff --git a/include/lttng/notification/notification.h b/include/lttng/notification/notification.h
index dcaf9745ad59d5335db480fd5c64f88e7a161624..ccee5108edba86f5cc7a0613c9c7ee754c7dd7bd 100644 (file)
--- a/include/lttng/notification/notification.h
+++ b/include/lttng/notification/notification.h
@@ -1,18 +1,8 @@
 /*
- * Copyright (C) 2017 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
+ * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
- * This library is free software; you can redistribute it and/or modify it
- * under the terms of the GNU Lesser General Public License, version 2.1 only,
- * as published by the Free Software Foundation.
+ * SPDX-License-Identifier: LGPL-2.1-only
  *
- * This library is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
- * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
- * for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this library; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 #ifndef LTTNG_NOTIFICATION_H
@@ -27,16 +17,51 @@ struct lttng_evaluation;
 struct lttng_notification;
 
 /*
- * The notification retains ownership of both the condition and evaluation.
- * Destroying the notification will also destroy the notification and evaluation
- * objects.
+ * Get a notification's condition.
+ *
+ * The notification retains the ownership of both the condition and evaluation
+ * objects. Hence, it is not valid to access those objects after the destruction
+ * of their associated notification.
+ *
+ * The caller should check the condition's type in order to use the appropriate
+ * specialized functions to access the condition's properties.
+ *
+ * Returns an lttng_condition object on success, NULL on error.
  */
 extern const struct lttng_condition *lttng_notification_get_condition(
                struct lttng_notification *notification);
 
+/*
+ * Get a notification's condition's evaluation.
+ *
+ * The notification retains the ownership of the evaluation object. Hence, it is
+ * not valid to access that object after the destruction of its associated
+ * notification.
+ *
+ * The caller should check the evaluation's type in order to use the appropriate
+ * specialized functions to access the evaluation's properties.
+ *
+ * Returns an lttng_evaluation object on success, NULL on error.
+ */
 extern const struct lttng_evaluation *lttng_notification_get_evaluation(
                struct lttng_notification *notification);
 
+/*
+ * Get a notification's origin trigger.
+ *
+ * The notification retains the ownership of the trigger object. Hence, it is
+ * not valid to access that object after the destruction of its associated
+ * notification.
+ *
+ * Returns an lttng_trigger object on success, NULL on error.
+ */
+const struct lttng_trigger *lttng_notification_get_trigger(
+               struct lttng_notification *notification);
+
+/*
+ * Destroys (frees) a notification. The notification's condition and evaluation
+ * are destroyed as a side-effect.
+ */
 extern void lttng_notification_destroy(struct lttng_notification *notification);
 
 #ifdef __cplusplus