2 * Copyright (C) 2013 Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 * SPDX-License-Identifier: LGPL-2.1-only
11 #include <lttng/lttng-export.h>
18 * The lttng_save_session_attr object is opaque to the user. Use the helper
19 * functions below to use them.
21 struct lttng_save_session_attr
;
24 * Return a newly allocated save session attribute object or NULL on error.
26 LTTNG_EXPORT
extern struct lttng_save_session_attr
*lttng_save_session_attr_create(void);
29 * Free a given save session attribute object.
31 LTTNG_EXPORT
extern void lttng_save_session_attr_destroy(struct lttng_save_session_attr
*output
);
35 * Save session attribute getter family functions.
38 /* Return session name. NULL indicated all sessions must be saved. */
39 LTTNG_EXPORT
extern const char *lttng_save_session_attr_get_session_name(
40 struct lttng_save_session_attr
*attr
);
42 * Return destination URL. A NULL value indicates the default session
43 * configuration location. The URL format used is documented in lttng(1).
44 * NULL indicates that the default session configuration path is used.
46 LTTNG_EXPORT
extern const char *lttng_save_session_attr_get_output_url(
47 struct lttng_save_session_attr
*attr
);
49 * Return the configuration overwrite attribute. This attribute indicates
50 * whether or not existing configuration files must be overwritten.
52 LTTNG_EXPORT
extern int lttng_save_session_attr_get_overwrite(
53 struct lttng_save_session_attr
*attr
);
55 * Return the omit name configuration attribute. This attribute indicates
56 * whether or not the saved sessions' names should be omitted.
58 LTTNG_EXPORT
extern int lttng_save_session_attr_get_omit_name(
59 struct lttng_save_session_attr
*attr
);
61 * Return the omit output configuration attribute. This attribute indicates
62 * whether or not the saved sessions' output configuration should be omitted.
64 LTTNG_EXPORT
extern int lttng_save_session_attr_get_omit_output(
65 struct lttng_save_session_attr
*attr
);
68 * Save session attribute setter family functions.
70 * For every set* call, 0 is returned on success or else -LTTNG_ERR_INVALID is
71 * returned indicating that at least one given parameter is invalid.
75 * Set the name of the session to save. A NULL name means all sessions
76 * known to the session daemon will be saved.
78 LTTNG_EXPORT
extern int lttng_save_session_attr_set_session_name(
79 struct lttng_save_session_attr
*attr
, const char *session_name
);
81 * Set the URL of the session configuration to save. A NULL value indicates the
82 * use of the default location being the session one. The URL's format is is
83 * documented in lttng(1).
85 LTTNG_EXPORT
extern int lttng_save_session_attr_set_output_url(
86 struct lttng_save_session_attr
*attr
, const char *url
);
88 * Set the overwrite attribute. If set to true, files of the same name as the
89 * current session configuration URL will be overwritten.
91 LTTNG_EXPORT
extern int lttng_save_session_attr_set_overwrite(
92 struct lttng_save_session_attr
*attr
, int overwrite
);
94 * Set the omit name attribute. If set to true, the sessions' names are omitted
95 * from the resulting session configuration file.
97 LTTNG_EXPORT
extern int lttng_save_session_attr_set_omit_name(
98 struct lttng_save_session_attr
*attr
, int omit_name
);
100 * Set the omit output attribute. If set to true, the sessions' output
101 * configurations are omitted from the resulting session configuration file.
103 LTTNG_EXPORT
extern int lttng_save_session_attr_set_omit_output(
104 struct lttng_save_session_attr
*attr
, int omit_output
);
107 * Save session configuration(s).
109 * The lttng_save_session_attr object must not be NULL. No ownership of the
110 * object is kept by the function; it must be released by the caller.
112 * Returns 0 on success or a negative LTTNG_ERR value on error.
114 LTTNG_EXPORT
extern int lttng_save_session(struct lttng_save_session_attr
*attr
);
120 #endif /* LTTNG_SAVE_H */
This page took 0.031598 seconds and 4 git commands to generate.