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 6c0d0ca257aee4ddab8ec61a870833beb1cbe877..b41ba0378f625dd8fdf9bcaeb347dd568645510d 100644 (file)
--- a/include/lttng/action/notify.h
+++ b/include/lttng/action/notify.h
@@ -1,31 +1,56 @@
 /*
- * 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_ACTION_NOTIFY_H
 #define LTTNG_ACTION_NOTIFY_H
 
 struct lttng_action;
+struct lttng_firing_policy;
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
+/*
+ * Create a newly allocated notification action object.
+ *
+ * A "notify" action will emit a notification to all clients which have an
+ * open notification channel. In order to receive this notification, clients
+ * 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