/*
- * 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
+#include <lttng/lttng-export.h>
+
struct lttng_action;
+struct lttng_rate_policy;
#ifdef __cplusplus
extern "C" {
* must have subscribed to a condition equivalent to the one paired to this
* notify action in a trigger.
*
+ * The default rate policy for a notify action is a "every 1" rate 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);
+LTTNG_EXPORT extern struct lttng_action *lttng_action_notify_create(void);
+
+/*
+ * Set the rate 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.
+ */
+LTTNG_EXPORT extern enum lttng_action_status
+lttng_action_notify_set_rate_policy(struct lttng_action *action,
+ const struct lttng_rate_policy *policy);
+
+/*
+ * Get the rate policy of a notify action.
+ *
+ * Returns LTTNG_ACTION_STATUS_OK on success,
+ * LTTNG_ACTION_STATUS_INVALID if invalid parameters are passed.
+ */
+LTTNG_EXPORT extern enum lttng_action_status
+lttng_action_notify_get_rate_policy(const struct lttng_action *action,
+ const struct lttng_rate_policy **policy);
#ifdef __cplusplus
}