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