LTTng control library C API
Loading...
Searching...
No Matches
clear-handle.h
1/*
2 * SPDX-FileCopyrightText: 2019 Jérémie Galarneau <jeremie.galarneau@efficios.com>
3 * SPDX-FileCopyrightText: 2019 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 *
5 * SPDX-License-Identifier: LGPL-2.1-only
6 *
7 */
8
9#ifndef LTTNG_CLEAR_HANDLE_H
10#define LTTNG_CLEAR_HANDLE_H
11
12#include <lttng/lttng-error.h>
13#include <lttng/lttng-export.h>
14
15#ifdef __cplusplus
16extern "C" {
17#endif
18
31
54
66LTTNG_EXPORT extern void lttng_clear_handle_destroy(struct lttng_clear_handle *handle);
67
105LTTNG_EXPORT extern enum lttng_clear_handle_status
107
151LTTNG_EXPORT extern enum lttng_clear_handle_status
153 enum lttng_error_code *result);
154
156
157#ifdef __cplusplus
158}
159#endif
160
161#endif /* LTTNG_CLEAR_HANDLE_H */
lttng_error_code
General error codes.
Definition lttng-error.h:49
lttng_clear_handle_status
Return type of recording session clearing handle functions.
Definition clear-handle.h:38
void lttng_clear_handle_destroy(struct lttng_clear_handle *handle)
Destroys the recording session clearing handle handle.
enum lttng_clear_handle_status lttng_clear_handle_get_result(const struct lttng_clear_handle *handle, enum lttng_error_code *result)
Sets *result to the result of the recording session clearing operation identified by handle.
enum lttng_clear_handle_status lttng_clear_handle_wait_for_completion(struct lttng_clear_handle *handle, int timeout_ms)
Waits for the recording session clearing operation identified by handle to complete.
@ LTTNG_CLEAR_HANDLE_STATUS_INVALID
Unsatisfied precondition.
Definition clear-handle.h:49
@ LTTNG_CLEAR_HANDLE_STATUS_ERROR
Other error.
Definition clear-handle.h:52
@ LTTNG_CLEAR_HANDLE_STATUS_COMPLETED
Recording session clearing operation completed.
Definition clear-handle.h:43
@ LTTNG_CLEAR_HANDLE_STATUS_TIMEOUT
Timeout reached.
Definition clear-handle.h:46
@ LTTNG_CLEAR_HANDLE_STATUS_OK
Success.
Definition clear-handle.h:40
Recording session clearing handle (opaque type).