include/lttng/destruction-handle.h

   1 /*
   2  * Copyright (C) 2019 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
   3  *
   4  * This library is free software; you can redistribute it and/or modify it
   5  * under the terms of the GNU Lesser General Public License, version 2.1 only,
   6  * as published by the Free Software Foundation.
   7  *
   8  * This library is distributed in the hope that it will be useful, but WITHOUT
   9  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
  11  * for more details.
  12  *
  13  * You should have received a copy of the GNU Lesser General Public License
  14  * along with this library; if not, write to the Free Software Foundation,
  15  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  16  */
  17
  18 #ifndef LTTNG_DESTRUCTION_HANDLE_H
  19 #define LTTNG_DESTRUCTION_HANDLE_H
  20
  21 #include <lttng/rotation.h>
  22 #include <lttng/lttng-error.h>
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif
  27
  28 struct lttng_destruction_handle;
  29
  30 enum lttng_destruction_handle_status {
  31         LTTNG_DESTRUCTION_HANDLE_STATUS_ERROR = -2,
  32         LTTNG_DESTRUCTION_HANDLE_STATUS_INVALID = -1,
  33         LTTNG_DESTRUCTION_HANDLE_STATUS_OK = 0,
  34         LTTNG_DESTRUCTION_HANDLE_STATUS_COMPLETED = 1,
  35         LTTNG_DESTRUCTION_HANDLE_STATUS_TIMEOUT = 2,
  36 };
  37
  38 extern void lttng_destruction_handle_destroy(
  39                 struct lttng_destruction_handle *handle);
  40
  41 extern enum lttng_destruction_handle_status
  42 lttng_destruction_handle_wait_for_completion(
  43                 struct lttng_destruction_handle *handle, int timeout_ms);
  44
  45 extern enum lttng_destruction_handle_status
  46 lttng_destruction_handle_get_result(
  47                 const struct lttng_destruction_handle *handle,
  48                 enum lttng_error_code *result);
  49
  50 extern enum lttng_destruction_handle_status
  51 lttng_destruction_handle_get_rotation_state(
  52                 const struct lttng_destruction_handle *handle,
  53                 enum lttng_rotation_state *rotation_state);
  54
  55 extern enum lttng_destruction_handle_status
  56 lttng_destruction_handle_get_archive_location(
  57                 const struct lttng_destruction_handle *handle,
  58                 const struct lttng_trace_archive_location **location);
  59
  60 #endif /* LTTNG_DESTRUCTION_HANDLE_H */