/*
- * Copyright (C) 2014 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
- * David Goulet <dgoulet@efficios.com>
+ * Copyright (C) 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
+ * Copyright (C) 2014 David Goulet <dgoulet@efficios.com>
*
- * This library is free software; you can redistribute it and/or modify it
- * under the terms of the GNU Lesser General Public License, version 2.1 only,
- * as published by the Free Software Foundation.
+ * SPDX-License-Identifier: LGPL-2.1-only
*
- * This library is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
- * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
- * for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this library; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef LTTNG_LOAD_H
/*
* The lttng_load_session_attr object is opaque to the user. Use the helper
- * functions below to use them.
+ * functions below to use it.
*/
struct lttng_load_session_attr;
/*
- * Save session attribute getter family functions.
+ * Load session attribute getter family of functions.
*/
-/* Return session name. NULL indicated all sessions must be loadd. */
+/* Return session name. NULL indicates all sessions must be loaded. */
const char *lttng_load_session_attr_get_session_name(
struct lttng_load_session_attr *attr);
/*
- * Return destination URL. A NULL value indicates the default session
- * configuration location. The URL format used is documented in lttng(1).
+ * Return input URL. A NULL value indicates the default session
+ * configuration location. The URL format used is documented in lttng-create(1).
* NULL indicates that the default session configuration path is used.
*/
const char *lttng_load_session_attr_get_input_url(
/*
* Return the configuration overwrite attribute. This attribute indicates
- * whether or not existing configuration files must be overwritten.
+ * whether or not the loaded session should be loaded even if a session with the
+ * same name already exists. If such a session exists, it is destroyed before
+ * the replacement is loaded.
*/
int lttng_load_session_attr_get_overwrite(
struct lttng_load_session_attr *attr);
/*
- * Save session attribute setter family functions.
+ * Return the destination URL configuration override attribute. This attribute
+ * indicates a destination URL override to be applied during the loading of the
+ * configuration.
+ *
+ * NULL indicates no override will be applied on configuration load.
+ */
+const char *lttng_load_session_attr_get_override_url(
+ struct lttng_load_session_attr *attr);
+
+/*
+ * Return the configuration override control URL attribute. This attribute
+ * indicates a control URL override to be applied during the loading of the
+ * configuration(s).
+ *
+ * NULL indicates no control URL override will be applied on configuration load.
+ */
+const char *lttng_load_session_attr_get_override_ctrl_url(
+ struct lttng_load_session_attr *attr);
+
+/*
+ * Return the configuration override data URL attribute. This attribute
+ * indicates a data URL override to be applied during the loading of the
+ * configuration(s).
+ *
+ * NULL indicates no data URL override will be applied on configuration load.
+ */
+const char *lttng_load_session_attr_get_override_data_url(
+ struct lttng_load_session_attr *attr);
+
+/*
+ * Return the configuration override session name attribute.
+ * This attribute indicates a session name override to be applied during
+ * the loading of the configuration(s).
+ *
+ * NULL indicates no session name override will be applied on configuration
+ * load.
+ */
+const char *lttng_load_session_attr_get_override_session_name(
+ struct lttng_load_session_attr *attr);
+
+/*
+ * Load session attribute setter family of functions.
*
* For every set* call, 0 is returned on success or else -LTTNG_ERR_INVALID is
* returned indicating that at least one given parameter is invalid.
/*
* Set the name of the session to load. A NULL name means all sessions
- * known to the session daemon will be loadd.
+ * found at the input URL will be loaded.
*/
int lttng_load_session_attr_set_session_name(
struct lttng_load_session_attr *attr, const char *session_name);
/*
* Set the URL of the session configuration to load. A NULL value indicates the
- * use of the default location being the session one.
+ * use of the default session configuration location.
*
* Note that file:// is the only supported URL format.
*/
struct lttng_load_session_attr *attr, const char *url);
/*
- * Set the overwrite attribute. If set to true, files of the same name as the
- * current session configuration URL will be overwritten.
+ * Set the overwrite attribute. If set to true, current sessions matching the
+ * loaded sessions will be destroyed and be replaced by the session(s) being
+ * loaded.
*/
int lttng_load_session_attr_set_overwrite(
struct lttng_load_session_attr *attr, int overwrite);
/*
- * Save session configuration(s).
+ * The following setter are for overriding sessions attributes during the
+ * loading of a configuration files. Those attributes prevail upon those
+ * specified in the loaded configuration file.
+ * */
+
+/*
+ * Set the url override attribute.
+ *
+ * Supported format:
+ * file://TRACEPATH
+ * NETPROTO://(HOST | IPADDR)[:CTRLPORT[:DATAPORT]][/TRACEPATH]
+ *
+ * Where NETPROTO is one of {tcp, tcp6}
+ *
+ * See lttng-create(1) for more detail.
+ */
+int lttng_load_session_attr_set_override_url(
+ struct lttng_load_session_attr *attr, const char *url);
+
+/*
+ * Set the control url override attribute.
+ *
+ * Supported format:
+ * NETPROTO://(HOST | IPADDR)[:PORT][/TRACEPATH]
+ *
+ * Where NETPROTO is one of {tcp, tcp6}
+ *
+ * See lttng-create(1) for more detail.
+ */
+int lttng_load_session_attr_set_override_ctrl_url(
+ struct lttng_load_session_attr *attr, const char *url);
+
+/*
+ * Set the data url override attribute.
+ *
+ * Supported format:
+ * NETPROTO://(HOST | IPADDR)[:PORT][/TRACEPATH]
+ *
+ * Where NETPROTO is one of {tcp, tcp6}
+ *
+ * See lttng-create(1) for more detail.
+ */
+int lttng_load_session_attr_set_override_data_url(
+ struct lttng_load_session_attr *attr, const char *url);
+
+/*
+ * Set the session name override attribute.
+ *
+ * Loading a configuration file defining multiple sessions will fail if a
+ * session name is provided.
+ */
+int lttng_load_session_attr_set_override_session_name(
+ struct lttng_load_session_attr *attr, const char *session_name);
+
+/*
+ * Load session configuration(s).
*
* The lttng_load_session_attr object must not be NULL. No ownership of the
* object is kept by the function; it must be released by the caller.
projects / lttng-tools.git / blobdiff