Implement firing policy for the notify action

[lttng-tools.git] / include / lttng / action / notify.h

diff --git a/include/lttng/action/notify.h b/include/lttng/action/notify.h
index 17a3e9da542ebfca4073ff2f1b39009da14cb72d..b41ba0378f625dd8fdf9bcaeb347dd568645510d 100644 (file)
--- a/include/lttng/action/notify.h
+++ b/include/lttng/action/notify.h
@@ -9,6 +9,7 @@
 #define LTTNG_ACTION_NOTIFY_H
 
 struct lttng_action;
+struct lttng_firing_policy;
 
 #ifdef __cplusplus
 extern "C" {
@@ -22,11 +23,34 @@ extern "C" {
  * must have subscribed to a condition equivalent to the one paired to this
  * notify action in a trigger.
  *
+ * The default firing policy for a notify action is a "every 1" firing policy.
+ *
  * Returns a new action on success, NULL on failure. This action must be
  * destroyed using lttng_action_destroy().
  */
 extern struct lttng_action *lttng_action_notify_create(void);
 
+/*
+ * Set the firing policy of a notify action.
+ *
+ * Returns LTTNG_ACTION_STATUS_OK on success,
+ * LTTNG_ACTION_STATUS_ERROR on internal error,
+ * LTTNG_ACTION_STATUS_INVALID if invalid parameters are passed.
+ */
+extern enum lttng_action_status lttng_action_notify_set_firing_policy(
+               struct lttng_action *action,
+               const struct lttng_firing_policy *policy);
+
+/*
+ * Get the firing policy of a notify action.
+ *
+ * Returns LTTNG_ACTION_STATUS_OK on success,
+ * LTTNG_ACTION_STATUS_INVALID if invalid parameters are passed.
+ */
+extern enum lttng_action_status lttng_action_notify_get_firing_policy(
+               const struct lttng_action *action,
+               const struct lttng_firing_policy **policy);
+
 #ifdef __cplusplus
 }
 #endif