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 | */ | |
28f23191 JG |
36 | LTTNG_EXPORT extern enum lttng_action_status |
37 | lttng_action_stop_session_set_session_name(struct lttng_action *action, const char *session_name); | |
931bdbaa SM |
38 | |
39 | /* | |
40 | * Get the session name of an lttng_action object of type | |
41 | * LTTNG_ACTION_TYPE_STOP_SESSION. | |
42 | */ | |
28f23191 JG |
43 | LTTNG_EXPORT extern enum lttng_action_status |
44 | lttng_action_stop_session_get_session_name(const struct lttng_action *action, | |
45 | const char **session_name); | |
931bdbaa | 46 | |
a5ec75db | 47 | /* |
7f4d5b07 | 48 | * Set the rate policy of a stop session action. |
a5ec75db JR |
49 | * |
50 | * Returns LTTNG_ACTION_STATUS_OK on success, | |
51 | * LTTNG_ACTION_STATUS_ERROR on internal error, | |
52 | * LTTNG_ACTION_STATUS_INVALID if invalid parameters are passed. | |
53 | */ | |
28f23191 JG |
54 | LTTNG_EXPORT extern enum lttng_action_status |
55 | lttng_action_stop_session_set_rate_policy(struct lttng_action *action, | |
56 | const struct lttng_rate_policy *policy); | |
a5ec75db JR |
57 | |
58 | /* | |
7f4d5b07 | 59 | * Get the rate policy of a stop session action. |
a5ec75db JR |
60 | * |
61 | * Returns LTTNG_ACTION_STATUS_OK on success, | |
62 | * LTTNG_ACTION_STATUS_INVALID if invalid parameters are passed. | |
63 | */ | |
28f23191 JG |
64 | LTTNG_EXPORT extern enum lttng_action_status |
65 | lttng_action_stop_session_get_rate_policy(const struct lttng_action *action, | |
66 | const struct lttng_rate_policy **policy); | |
a5ec75db | 67 | |
931bdbaa SM |
68 | #ifdef __cplusplus |
69 | } | |
70 | #endif | |
71 | ||
72 | #endif /* LTTNG_ACTION_STOP_SESSION_H */ |