include/lttng/action/action.h

   1 /*
   2  * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   3  *
   4  * SPDX-License-Identifier: LGPL-2.1-only
   5  *
   6  */
   7
   8 #ifndef LTTNG_ACTION_H
   9 #define LTTNG_ACTION_H
  10
  11 struct lttng_action;
  12
  13 #ifdef __cplusplus
  14 extern "C" {
  15 #endif
  16
  17 enum lttng_action_type {
  18         LTTNG_ACTION_TYPE_UNKNOWN = -1,
  19         LTTNG_ACTION_TYPE_NOTIFY = 0,
  20         LTTNG_ACTION_TYPE_START_SESSION = 1,
  21         LTTNG_ACTION_TYPE_STOP_SESSION = 2,
  22         LTTNG_ACTION_TYPE_ROTATE_SESSION = 3,
  23         LTTNG_ACTION_TYPE_SNAPSHOT_SESSION = 4,
  24         LTTNG_ACTION_TYPE_GROUP = 5,
  25 };
  26
  27 enum lttng_action_status {
  28         LTTNG_ACTION_STATUS_OK = 0,
  29         LTTNG_ACTION_STATUS_ERROR = -1,
  30         LTTNG_ACTION_STATUS_UNKNOWN = -2,
  31         LTTNG_ACTION_STATUS_INVALID = -3,
  32         LTTNG_ACTION_STATUS_UNSET = -4,
  33 };
  34
  35 /*
  36  * Get the type of an action.
  37  *
  38  * Returns the type of an action on success, LTTNG_ACTION_TYPE_UNKNOWN on error.
  39  */
  40 extern enum lttng_action_type lttng_action_get_type(
  41                 struct lttng_action *action);
  42
  43 /*
  44  * Destroy (frees) an action object.
  45  */
  46 extern void lttng_action_destroy(struct lttng_action *action);
  47
  48 #ifdef __cplusplus
  49 }
  50 #endif
  51
  52 #endif /* LTTNG_ACTION_H */