Docs: document the lttng_condition API
[lttng-tools.git] / include / lttng / condition / condition.h
CommitLineData
a58c490f
JG
1/*
2 * Copyright (C) 2017 - 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_CONDITION_H
19#define LTTNG_CONDITION_H
20
21#include <lttng/lttng.h>
22
23#ifdef __cplusplus
24extern "C" {
25#endif
26
27struct lttng_condition;
28
29enum lttng_condition_type {
30 LTTNG_CONDITION_TYPE_UNKNOWN = -1,
31 LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW = 102,
32 LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH = 101,
33};
34
35enum lttng_condition_status {
36 LTTNG_CONDITION_STATUS_OK = 0,
37 LTTNG_CONDITION_STATUS_ERROR = -1,
38 LTTNG_CONDITION_STATUS_UNKNOWN = -2,
39 LTTNG_CONDITION_STATUS_INVALID = -3,
40 LTTNG_CONDITION_STATUS_UNSET = -4,
41};
42
a6d9b795
JG
43/*
44 * Get the type of a condition.
45 *
46 * Returns the type of a condition on success, LTTNG_CONDITION_TYPE_UNKNOWN on
47 * error.
48 */
a58c490f
JG
49extern enum lttng_condition_type lttng_condition_get_type(
50 const struct lttng_condition *condition);
51
a6d9b795
JG
52/*
53 * Destroy (frees) a condition object.
54 */
a58c490f
JG
55extern void lttng_condition_destroy(struct lttng_condition *condition);
56
57#ifdef __cplusplus
58}
59#endif
60
61#endif /* LTTNG_CONDITION_H */
This page took 0.038021 seconds and 5 git commands to generate.