X-Git-Url: http://git.efficios.com/?p=lttng-tools.git;a=blobdiff_plain;f=include%2Flttng%2Fsession.h;h=8ba8179136f09931ed66e21247fa3124d69e408f;hp=6c54d7e4f5e55fc5fe4dde03ff8a4812e5411a97;hb=3e3665b89947ebdd812bcfaca1090d22b34d5778;hpb=fcf0f774e2b567e5dcf9190a84973b7a4e06eb7d diff --git a/include/lttng/session.h b/include/lttng/session.h index 6c54d7e4f..8ba817913 100644 --- a/include/lttng/session.h +++ b/include/lttng/session.h @@ -1,5 +1,6 @@ /* * Copyright (C) 2014 - David Goulet + * Copyright (C) 2019 - Jérémie Galarneau * * 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, @@ -23,6 +24,7 @@ extern "C" { #endif struct lttng_session_descriptor; +struct lttng_destruction_handle; /* * Basic session information. @@ -128,10 +130,25 @@ extern int lttng_create_session_live(const char *name, const char *url, * * The name can't be NULL here. * - * Return 0 on success else a negative LTTng error code. + * Returns LTTNG_OK on success, else a negative LTTng error code. */ extern int lttng_destroy_session(const char *name); +/* + * Destroy a tracing session. + * + * Performs the same function as lttng_destroy_session(), but provides + * an lttng_destruction_handle which can be used to wait for the completion + * of the session's destruction. The lttng_destroy_handle can also be used + * obtain the status and archive location of any implicit session + * rotation that may have occured during the session's destruction. + * + * 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); + /* * Behaves exactly like lttng_destroy_session but does not wait for data * availability.