Docs: document the lttng_action API
[lttng-tools.git] / include / lttng / action / action.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_ACTION_H
19 #define LTTNG_ACTION_H
20
21 struct lttng_action;
22
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26
27 enum lttng_action_type {
28 LTTNG_ACTION_TYPE_UNKNOWN = -1,
29 LTTNG_ACTION_TYPE_NOTIFY = 0,
30 };
31
32 /*
33 * Get the type of an action.
34 *
35 * Returns the type of an action on success, LTTNG_ACTION_TYPE_UNKNOWN on error.
36 */
37 extern enum lttng_action_type lttng_action_get_type(
38 struct lttng_action *action);
39
40 /*
41 * Destroy (frees) an action object.
42 */
43 extern void lttng_action_destroy(struct lttng_action *action);
44
45 #ifdef __cplusplus
46 }
47 #endif
48
49 #endif /* LTTNG_ACTION_H */
This page took 0.032172 seconds and 6 git commands to generate.