projects / lttng-tools.git / blame
| Commit | Line | Data |
|---|---|---|
| 931bdbaa SM |
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_STOP_SESSION_H | |
| 9 | #define LTTNG_ACTION_STOP_SESSION_H | |
| 10 | ||
| 4bd69c5f SM |
11 | #include <lttng/lttng-export.h> |
| 12 | ||
| 931bdbaa | 13 | struct lttng_action; |
| 7f4d5b07 | 14 | struct lttng_rate_policy; |
| 931bdbaa SM |
15 | |
| 16 | #ifdef __cplusplus | |
| 17 | extern "C" { | |
| 18 | #endif | |
| 19 | ||
| 20 | /* | |
| 21 | * Create a newly allocated stop-session action object. | |
| 22 | * | |
| 23 | * A stop 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_stop_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 | */ | |
| 4bd69c5f | 30 | LTTNG_EXPORT extern struct lttng_action *lttng_action_stop_session_create(void); |
| 931bdbaa SM |
31 | |
| 32 | /* | |
| 33 | * Set the session name of an lttng_action object of type | |
| 34 | * LTTNG_ACTION_TYPE_STOP_SESSION. | |
| 35 | */ | |
| 4bd69c5f | 36 | LTTNG_EXPORT extern enum lttng_action_status lttng_action_stop_session_set_session_name( |
| 931bdbaa SM |
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_STOP_SESSION. | |
| 42 | */ | |
| 4bd69c5f | 43 | LTTNG_EXPORT extern enum lttng_action_status lttng_action_stop_session_get_session_name( |
| 931bdbaa SM |
44 | const struct lttng_action *action, const char **session_name); |
| 45 | ||
| a5ec75db | 46 | /* |
| 7f4d5b07 | 47 | * Set the rate policy of a stop session action. |
| a5ec75db JR |
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 | */ | |
| 4bd69c5f | 53 | LTTNG_EXPORT extern enum lttng_action_status lttng_action_stop_session_set_rate_policy( |
| a5ec75db | 54 | struct lttng_action *action, |
| 7f4d5b07 | 55 | const struct lttng_rate_policy *policy); |
| a5ec75db JR |
56 | |
| 57 | /* | |
| 7f4d5b07 | 58 | * Get the rate policy of a stop session action. |
| a5ec75db JR |
59 | * |
| 60 | * Returns LTTNG_ACTION_STATUS_OK on success, | |
| 61 | * LTTNG_ACTION_STATUS_INVALID if invalid parameters are passed. | |
| 62 | */ | |
| 4bd69c5f | 63 | LTTNG_EXPORT extern enum lttng_action_status lttng_action_stop_session_get_rate_policy( |
| a5ec75db | 64 | const struct lttng_action *action, |
| 7f4d5b07 | 65 | const struct lttng_rate_policy **policy); |
| a5ec75db | 66 | |
| 931bdbaa SM |
67 | #ifdef __cplusplus |
| 68 | } | |
| 69 | #endif | |
| 70 | ||
| 71 | #endif /* LTTNG_ACTION_STOP_SESSION_H */ |