actions: introduce rotate session action

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

diff --git a/include/lttng/action/action.h b/include/lttng/action/action.h
index 311f5a0fb2924872dde21c4e59df4998f3d075a4..03f2964f3ae08cef8c2d265a2bfaffade7e78217 100644 (file)
--- a/include/lttng/action/action.h
+++ b/include/lttng/action/action.h
@@ -1,18 +1,8 @@
 /*
- * 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_H
@@ -27,11 +17,30 @@ extern "C" {
 enum lttng_action_type {
        LTTNG_ACTION_TYPE_UNKNOWN = -1,
        LTTNG_ACTION_TYPE_NOTIFY = 0,
+       LTTNG_ACTION_TYPE_START_SESSION = 1,
+       LTTNG_ACTION_TYPE_STOP_SESSION = 2,
+       LTTNG_ACTION_TYPE_ROTATE_SESSION = 3,
+};
+
+enum lttng_action_status {
+       LTTNG_ACTION_STATUS_OK = 0,
+       LTTNG_ACTION_STATUS_ERROR = -1,
+       LTTNG_ACTION_STATUS_UNKNOWN = -2,
+       LTTNG_ACTION_STATUS_INVALID = -3,
+       LTTNG_ACTION_STATUS_UNSET = -4,
 };
 
+/*
+ * Get the type of an action.
+ *
+ * Returns the type of an action on success, LTTNG_ACTION_TYPE_UNKNOWN on error.
+ */
 extern enum lttng_action_type lttng_action_get_type(
                struct lttng_action *action);
 
+/*
+ * Destroy (frees) an action object.
+ */
 extern void lttng_action_destroy(struct lttng_action *action);
 
 #ifdef __cplusplus