2 * Copyright (C) 2014 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
3 * David Goulet <dgoulet@efficios.com>
5 * This library is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU Lesser General Public License, version 2.1 only,
7 * as published by the Free Software Foundation.
9 * This library is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
14 * You should have received a copy of the GNU Lesser General Public License
15 * along with this library; if not, write to the Free Software Foundation,
16 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
27 * The lttng_load_session_attr object is opaque to the user. Use the helper
28 * functions below to use them.
30 struct lttng_load_session_attr
;
33 * Return a newly allocated load session attribute object or NULL on error.
35 struct lttng_load_session_attr
*lttng_load_session_attr_create(void);
38 * Free a given load session attribute object.
40 void lttng_load_session_attr_destroy(struct lttng_load_session_attr
*attr
);
44 * Load session attribute getter family functions.
47 /* Return session name. NULL indicated all sessions must be loaded. */
48 const char *lttng_load_session_attr_get_session_name(
49 struct lttng_load_session_attr
*attr
);
51 * Return input URL. A NULL value indicates the default session
52 * configuration location. The URL format used is documented in lttng-create(1).
53 * NULL indicates that the default session configuration path is used.
55 const char *lttng_load_session_attr_get_input_url(
56 struct lttng_load_session_attr
*attr
);
59 * Return the configuration overwrite attribute. This attribute indicates
60 * whether or not the loaded session is loaded even if a session with the same
61 * name already exist. If so the existing session is deleted before the
62 * replacement is loaded.
64 int lttng_load_session_attr_get_overwrite(
65 struct lttng_load_session_attr
*attr
);
67 * Return the configuration override path url attribute. This attribute
68 * indicate an override to be applied during the loading of the configuration.
69 * Null indicates no override will be applied on configuration load.
71 * Caller is responsible for freeing the return value.
73 const char *lttng_load_session_attr_get_override_path_url(
74 struct lttng_load_session_attr
*attr
);
77 * Return the configuration override control url attribute. This attribute
78 * indicate an override to be applied during the loading of the configuration.
79 * Null indicates no override will be applied on configuration load.
81 * Caller is responsible for freeing the return value.
83 const char *lttng_load_session_attr_get_override_ctrl_url(
84 struct lttng_load_session_attr
*attr
);
87 * Return the configuration override data url attribute. This attribute
88 * indicate an override to be applied during the loading of the configuration.
89 * Null indicates no override will be applied on configuration load.
91 * Caller is responsible for freeing the return value.
93 const char *lttng_load_session_attr_get_override_data_url(
94 struct lttng_load_session_attr
*attr
);
97 * Return the configuration override url attribute. This attribute
98 * indicate an override to be applied during the loading of the configuration.
99 * Null indicates no override will be applied on configuration load.
101 * Caller is responsible for freeing the return value.
103 const char *lttng_load_session_attr_get_override_url(
104 struct lttng_load_session_attr
*attr
);
107 * Load session attribute setter family functions.
109 * For every set* call, 0 is returned on success or else -LTTNG_ERR_INVALID is
110 * returned indicating that at least one given parameter is invalid.
114 * Set the name of the session to load. A NULL name means all sessions
115 * known to the session daemon will be loaded.
117 int lttng_load_session_attr_set_session_name(
118 struct lttng_load_session_attr
*attr
, const char *session_name
);
121 * Set the URL of the session configuration to load. A NULL value indicates the
122 * use of the default location being the session one.
124 * Note that file:// is the only supported URL format.
126 int lttng_load_session_attr_set_input_url(
127 struct lttng_load_session_attr
*attr
, const char *url
);
130 * Set the overwrite attribute. If set to true, current session matching the
131 * loaded sessions will be deleted and the loaded sessions created.
133 int lttng_load_session_attr_set_overwrite(
134 struct lttng_load_session_attr
*attr
, int overwrite
);
137 * The following setter are for overriding sessions attributes during the
138 * loading of a configuration files. Those attributes prevail upon those
139 * specified in the loaded configuration file.
143 * Set the path url override attribute.
148 int lttng_load_session_attr_set_override_path_url(
149 struct lttng_load_session_attr
*attr
, const char *url
);
152 * Set the control url override attribute.
155 * NETPROTO://(HOST | IPADDR)[:PORT][/TRACEPATH]
157 * Where NETPROTO is one of tcp,tcp6
159 * See lttng-create(1) for more detail.
161 int lttng_load_session_attr_set_override_ctrl_url(
162 struct lttng_load_session_attr
*attr
, const char *url
);
165 * Set the data url override attribute.
168 * NETPROTO://(HOST | IPADDR)[:PORT][/TRACEPATH]
170 * Where NETPROTO is one of tcp,tcp6
172 * See lttng-create(1) for more detail.
174 int lttng_load_session_attr_set_override_data_url(
175 struct lttng_load_session_attr
*attr
, const char *url
);
178 * Set the url override attribute.
182 * NETPROTO://(HOST | IPADDR)[:CTRLPORT[:DATAPORT]][/TRACEPATH]
184 * See lttng-create(1) for more detail.
186 int lttng_load_session_attr_set_override_url(
187 struct lttng_load_session_attr
*attr
, const char *url
);
189 * Load session configuration(s).
191 * The lttng_load_session_attr object must not be NULL. No ownership of the
192 * object is kept by the function; it must be released by the caller.
194 * Returns 0 on success or a negative LTTNG_ERR value on error.
196 int lttng_load_session(struct lttng_load_session_attr
*attr
);
202 #endif /* LTTNG_LOAD_H */
This page took 0.052032 seconds and 6 git commands to generate.