include/lttng/action/rotate-session.h

   1 /*
   2  * Copyright (C) 2019 Simon Marchi <simon.marchi@efficios.com>
   3  *
   4  * SPDX-License-Identifier: LGPL-2.1-only
   5  *
   6  */
   7
   8 #ifndef LTTNG_ACTION_ROTATE_SESSION_H
   9 #define LTTNG_ACTION_ROTATE_SESSION_H
  10
  11 #include <lttng/lttng-export.h>
  12
  13 struct lttng_action;
  14 struct lttng_rate_policy;
  15
  16 #ifdef __cplusplus
  17 extern "C" {
  18 #endif
  19
  20 /*
  21  * Create a newly allocated rotate-session action object.
  22  *
  23  * A rotate session action object must have a session name set to be considered
  24  * valid when used with a trigger object (lttng_trigger). A name can be set
  25  * using `lttng_action_rotate_session_set_session_name`.
  26  *
  27  * Returns a new action on success, NULL on failure. This action must be
  28  * destroyed using lttng_action_destroy().
  29  */
  30 LTTNG_EXPORT extern struct lttng_action *lttng_action_rotate_session_create(void);
  31
  32 /*
  33  * Set the session name of an lttng_action object of type
  34  * LTTNG_ACTION_TYPE_ROTATE_SESSION.
  35  */
  36 LTTNG_EXPORT extern enum lttng_action_status lttng_action_rotate_session_set_session_name(
  37                 struct lttng_action *action, const char *session_name);
  38
  39 /*
  40  * Get the session name of an lttng_action object of type
  41  * LTTNG_ACTION_TYPE_ROTATE_SESSION.
  42  */
  43 LTTNG_EXPORT extern enum lttng_action_status lttng_action_rotate_session_get_session_name(
  44                 const struct lttng_action *action, const char **session_name);
  45
  46 /*
  47  * Set the rate policy of a rotate session action.
  48  *
  49  * Returns LTTNG_ACTION_STATUS_OK on success,
  50  * LTTNG_ACTION_STATUS_ERROR on internal error,
  51  * LTTNG_ACTION_STATUS_INVALID if invalid parameters are passed.
  52  */
  53 LTTNG_EXPORT extern enum lttng_action_status lttng_action_rotate_session_set_rate_policy(
  54                 struct lttng_action *action,
  55                 const struct lttng_rate_policy *policy);
  56
  57 /*
  58  * Get the rate policy of a rotate session action.
  59  *
  60  * Returns LTTNG_ACTION_STATUS_OK on success,
  61  * LTTNG_ACTION_STATUS_INVALID if invalid parameters are passed.
  62  */
  63 LTTNG_EXPORT extern enum lttng_action_status lttng_action_rotate_session_get_rate_policy(
  64                 const struct lttng_action *action,
  65                 const struct lttng_rate_policy **policy);
  66
  67 #ifdef __cplusplus
  68 }
  69 #endif
  70
  71 #endif /* LTTNG_ACTION_ROTATE_SESSION_H */