2 * Copyright (C) 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
3 * Copyright (C) 2014 David Goulet <dgoulet@efficios.com>
5 * SPDX-License-Identifier: LGPL-2.1-only
17 * The lttng_load_session_attr object is opaque to the user. Use the helper
18 * functions below to use it.
20 struct lttng_load_session_attr
;
23 * Return a newly allocated load session attribute object or NULL on error.
25 struct lttng_load_session_attr
*lttng_load_session_attr_create(void);
28 * Free a given load session attribute object.
30 void lttng_load_session_attr_destroy(struct lttng_load_session_attr
*attr
);
34 * Load session attribute getter family of functions.
37 /* Return session name. NULL indicates all sessions must be loaded. */
38 const char *lttng_load_session_attr_get_session_name(
39 struct lttng_load_session_attr
*attr
);
41 * Return input URL. A NULL value indicates the default session
42 * configuration location. The URL format used is documented in lttng-create(1).
43 * NULL indicates that the default session configuration path is used.
45 const char *lttng_load_session_attr_get_input_url(
46 struct lttng_load_session_attr
*attr
);
49 * Return the configuration overwrite attribute. This attribute indicates
50 * whether or not the loaded session should be loaded even if a session with the
51 * same name already exists. If such a session exists, it is destroyed before
52 * the replacement is loaded.
54 int lttng_load_session_attr_get_overwrite(
55 struct lttng_load_session_attr
*attr
);
58 * Return the destination URL configuration override attribute. This attribute
59 * indicates a destination URL override to be applied during the loading of the
62 * NULL indicates no override will be applied on configuration load.
64 const char *lttng_load_session_attr_get_override_url(
65 struct lttng_load_session_attr
*attr
);
68 * Return the configuration override control URL attribute. This attribute
69 * indicates a control URL override to be applied during the loading of the
72 * NULL indicates no control URL override will be applied on configuration load.
74 const char *lttng_load_session_attr_get_override_ctrl_url(
75 struct lttng_load_session_attr
*attr
);
78 * Return the configuration override data URL attribute. This attribute
79 * indicates a data URL override to be applied during the loading of the
82 * NULL indicates no data URL override will be applied on configuration load.
84 const char *lttng_load_session_attr_get_override_data_url(
85 struct lttng_load_session_attr
*attr
);
88 * Return the configuration override session name attribute.
89 * This attribute indicates a session name override to be applied during
90 * the loading of the configuration(s).
92 * NULL indicates no session name override will be applied on configuration
95 const char *lttng_load_session_attr_get_override_session_name(
96 struct lttng_load_session_attr
*attr
);
99 * Load session attribute setter family of functions.
101 * For every set* call, 0 is returned on success or else -LTTNG_ERR_INVALID is
102 * returned indicating that at least one given parameter is invalid.
106 * Set the name of the session to load. A NULL name means all sessions
107 * found at the input URL will be loaded.
109 int lttng_load_session_attr_set_session_name(
110 struct lttng_load_session_attr
*attr
, const char *session_name
);
113 * Set the URL of the session configuration to load. A NULL value indicates the
114 * use of the default session configuration location.
116 * Note that file:// is the only supported URL format.
118 int lttng_load_session_attr_set_input_url(
119 struct lttng_load_session_attr
*attr
, const char *url
);
122 * Set the overwrite attribute. If set to true, current sessions matching the
123 * loaded sessions will be destroyed and be replaced by the session(s) being
126 int lttng_load_session_attr_set_overwrite(
127 struct lttng_load_session_attr
*attr
, int overwrite
);
130 * The following setter are for overriding sessions attributes during the
131 * loading of a configuration files. Those attributes prevail upon those
132 * specified in the loaded configuration file.
136 * Set the url override attribute.
140 * NETPROTO://(HOST | IPADDR)[:CTRLPORT[:DATAPORT]][/TRACEPATH]
142 * Where NETPROTO is one of {tcp, tcp6}
144 * See lttng-create(1) for more detail.
146 int lttng_load_session_attr_set_override_url(
147 struct lttng_load_session_attr
*attr
, const char *url
);
150 * Set the control url override attribute.
153 * NETPROTO://(HOST | IPADDR)[:PORT][/TRACEPATH]
155 * Where NETPROTO is one of {tcp, tcp6}
157 * See lttng-create(1) for more detail.
159 int lttng_load_session_attr_set_override_ctrl_url(
160 struct lttng_load_session_attr
*attr
, const char *url
);
163 * Set the data url override attribute.
166 * NETPROTO://(HOST | IPADDR)[:PORT][/TRACEPATH]
168 * Where NETPROTO is one of {tcp, tcp6}
170 * See lttng-create(1) for more detail.
172 int lttng_load_session_attr_set_override_data_url(
173 struct lttng_load_session_attr
*attr
, const char *url
);
176 * Set the session name override attribute.
178 * Loading a configuration file defining multiple sessions will fail if a
179 * session name is provided.
181 int lttng_load_session_attr_set_override_session_name(
182 struct lttng_load_session_attr
*attr
, const char *session_name
);
185 * Load session configuration(s).
187 * The lttng_load_session_attr object must not be NULL. No ownership of the
188 * object is kept by the function; it must be released by the caller.
190 * Returns 0 on success or a negative LTTNG_ERR value on error.
192 int lttng_load_session(struct lttng_load_session_attr
*attr
);
198 #endif /* LTTNG_LOAD_H */
This page took 0.033074 seconds and 4 git commands to generate.