2 * Copyright (C) 2019 Simon Marchi <simon.marchi@efficios.com>
4 * SPDX-License-Identifier: LGPL-2.1-only
8 #ifndef LTTNG_ACTION_SNAPSHOT_SESSION_H
9 #define LTTNG_ACTION_SNAPSHOT_SESSION_H
11 #include <lttng/lttng-export.h>
18 struct lttng_snapshot_output
;
19 struct lttng_rate_policy
;
22 * Create a newly allocated snapshot-session action object.
24 * A snapshot session action object must have a session name set to be
25 * considered valid when used with a trigger object (lttng_trigger). A name can
26 * be set using `lttng_action_snapshot_session_set_session_name`.
28 * Returns a new action on success, NULL on failure. This action must be
29 * destroyed using lttng_action_destroy().
31 LTTNG_EXPORT
extern struct lttng_action
*lttng_action_snapshot_session_create(void);
34 * Set the session name of an lttng_action object of type
35 * LTTNG_ACTION_TYPE_SNAPSHOT_SESSION.
37 LTTNG_EXPORT
extern enum lttng_action_status
lttng_action_snapshot_session_set_session_name(
38 struct lttng_action
*action
, const char *session_name
);
41 * Get the session name of an lttng_action object of type
42 * LTTNG_ACTION_TYPE_SNAPSHOT_SESSION.
44 LTTNG_EXPORT
extern enum lttng_action_status
lttng_action_snapshot_session_get_session_name(
45 const struct lttng_action
*action
, const char **session_name
);
48 * Set an explicit snapshot output for this snapshot session action.
50 * The given snapshot output will be used instead of the session's
51 * default snapshot output.
53 * This function takes ownership of the given snapshot output.
55 LTTNG_EXPORT
extern enum lttng_action_status
lttng_action_snapshot_session_set_output(
56 struct lttng_action
*action
,
57 struct lttng_snapshot_output
*output
);
60 * Get the explicit snapshot output for this snapshot session action.
62 LTTNG_EXPORT
extern enum lttng_action_status
lttng_action_snapshot_session_get_output(
63 const struct lttng_action
*action
,
64 const struct lttng_snapshot_output
**output
);
67 * Set the rate policy of a snapshot session action.
69 * Returns LTTNG_ACTION_STATUS_OK on success,
70 * LTTNG_ACTION_STATUS_ERROR on internal error,
71 * LTTNG_ACTION_STATUS_INVALID if invalid parameters are passed.
73 LTTNG_EXPORT
extern enum lttng_action_status
lttng_action_snapshot_session_set_rate_policy(
74 struct lttng_action
*action
,
75 const struct lttng_rate_policy
*policy
);
78 * Get the rate policy of a snapshot session action.
80 * Returns LTTNG_ACTION_STATUS_OK on success,
81 * LTTNG_ACTION_STATUS_INVALID if invalid parameters are passed.
83 LTTNG_EXPORT
extern enum lttng_action_status
lttng_action_snapshot_session_get_rate_policy(
84 const struct lttng_action
*action
,
85 const struct lttng_rate_policy
**policy
);
91 #endif /* LTTNG_ACTION_SNAPSHOT_SESSION_H */
This page took 0.030389 seconds and 4 git commands to generate.