scope-exit: Clarify scope_exit noexcept requirement

[lttng-tools.git] / include / lttng / session.h

diff --git a/include/lttng/session.h b/include/lttng/session.h
index b8a2b7dcc91b18fff4b2181c0ad54be7bf0e1a4d..9be506fc196bbda6e956134733739faac734a2ce 100644 (file)
--- a/include/lttng/session.h
+++ b/include/lttng/session.h
@@ -1,19 +1,9 @@
 /*
- * Copyright (C) 2014 - David Goulet <dgoulet@efficios.com>
- * Copyright (C) 2019 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
+ * Copyright (C) 2014 David Goulet <dgoulet@efficios.com>
+ * Copyright (C) 2019 Jérémie Galarneau <jeremie.galarneau@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_SESSION_H
@@ -24,6 +14,7 @@ extern "C" {
 #endif
 
 #include <lttng/constant.h>
+#include <lttng/lttng-export.h>
 
 struct lttng_handle;
 struct lttng_session_descriptor;
@@ -37,7 +28,7 @@ struct lttng_destruction_handle;
  *
  * The structures should be initialized to zero before use.
  */
-#define LTTNG_SESSION_PADDING1             8
+#define LTTNG_SESSION_PADDING1 8
 struct lttng_session {
        char name[LTTNG_NAME_MAX];
        /*
@@ -50,9 +41,9 @@ struct lttng_session {
         *     net://hostname/path:ctrl_port [data: data_port]
         */
        char path[PATH_MAX];
-       uint32_t enabled;       /* enabled/started: 1, disabled/stopped: 0 */
+       uint32_t enabled; /* enabled/started: 1, disabled/stopped: 0 */
        uint32_t snapshot_mode;
-       unsigned int live_timer_interval;       /* usec */
+       unsigned int live_timer_interval; /* usec */
 
        /*
         * End of public attributes.
@@ -96,8 +87,8 @@ struct lttng_session {
  * Returns LTTNG_OK on success. See lttng-error.h for the meaning of the other
  * return codes.
  */
-extern enum lttng_error_code lttng_create_session_ext(
-               struct lttng_session_descriptor *session_descriptor);
+LTTNG_EXPORT extern enum lttng_error_code
+lttng_create_session_ext(struct lttng_session_descriptor *session_descriptor);
 
 /*
  * Create a tracing session using a name and an optional URL.
@@ -107,7 +98,7 @@ extern enum lttng_error_code lttng_create_session_ext(
  *
  * Return 0 on success else a negative LTTng error code.
  */
-extern int lttng_create_session(const char *name, const char *url);
+LTTNG_EXPORT extern int lttng_create_session(const char *name, const char *url);
 
 /*
  * Create a tracing session that will exclusively be used for snapshot meaning
@@ -121,8 +112,7 @@ extern int lttng_create_session(const char *name, const char *url);
  *
  * Return 0 on success else a negative LTTng error code.
  */
-extern int lttng_create_session_snapshot(const char *name,
-               const char *snapshot_url);
+LTTNG_EXPORT extern int lttng_create_session_snapshot(const char *name, const char *snapshot_url);
 
 /*
  * Create a session exclusively used for live reading.
@@ -137,8 +127,8 @@ extern int lttng_create_session_snapshot(const char *name,
  *
  * Return 0 on success else a negative LTTng error code.
  */
-extern int lttng_create_session_live(const char *name, const char *url,
-               unsigned int timer_interval);
+LTTNG_EXPORT extern int
+lttng_create_session_live(const char *name, const char *url, unsigned int timer_interval);
 
 /*
  * Destroy a tracing session.
@@ -157,7 +147,7 @@ extern int lttng_create_session_live(const char *name, const char *url,
  *
  * Return 0 on success else a negative LTTng error code.
  */
-extern int lttng_destroy_session(const char *name);
+LTTNG_EXPORT extern int lttng_destroy_session(const char *name);
 
 /*
  * Destroy a tracing session.
@@ -171,14 +161,14 @@ extern int lttng_destroy_session(const char *name);
  * Returns LTTNG_OK on success. The returned handle is owned by the caller
  * and must be free'd using lttng_destruction_handle_destroy().
  */
-extern enum lttng_error_code lttng_destroy_session_ext(const char *session_name,
-               struct lttng_destruction_handle **handle);
+LTTNG_EXPORT extern enum lttng_error_code
+lttng_destroy_session_ext(const char *session_name, struct lttng_destruction_handle **handle);
 
 /*
  * Behaves exactly like lttng_destroy_session but does not wait for data
  * availability.
  */
-extern int lttng_destroy_session_no_wait(const char *name);
+LTTNG_EXPORT extern int lttng_destroy_session_no_wait(const char *name);
 
 /*
  * List all the tracing sessions.
@@ -188,7 +178,7 @@ extern int lttng_destroy_session_no_wait(const char *name);
  *
  * On error, a negative LTTng error code is returned.
  */
-extern int lttng_list_sessions(struct lttng_session **sessions);
+LTTNG_EXPORT extern int lttng_list_sessions(struct lttng_session **sessions);
 
 /*
  * Get the creation time of an lttng_session object on the session daemon.
@@ -202,8 +192,8 @@ extern int lttng_list_sessions(struct lttng_session **sessions);
  * Returns LTTNG_OK on success. See lttng-error.h for the meaning of the other
  * return codes.
  */
-extern enum lttng_error_code lttng_session_get_creation_time(
-               const struct lttng_session *session, uint64_t *creation_time);
+LTTNG_EXPORT extern enum lttng_error_code
+lttng_session_get_creation_time(const struct lttng_session *session, uint64_t *creation_time);
 
 /*
  * Set the shared memory path for a session.
@@ -214,8 +204,7 @@ extern enum lttng_error_code lttng_session_get_creation_time(
  *
  * Return 0 on success else a negative LTTng error code.
  */
-extern int lttng_set_session_shm_path(const char *session_name,
-               const char *shm_path);
+LTTNG_EXPORT extern int lttng_set_session_shm_path(const char *session_name, const char *shm_path);
 
 #ifdef __cplusplus
 }