lib: strictly type function return status enumerations
[babeltrace.git] / include / babeltrace2 / graph / query-executor.h
1 #ifndef BABELTRACE_GRAPH_QUERY_EXECUTOR_H
2 #define BABELTRACE_GRAPH_QUERY_EXECUTOR_H
3
4 /*
5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 * SOFTWARE.
24 */
25
26 /* For bt_query_executor, bt_component_class, bt_value */
27 #include <babeltrace2/types.h>
28
29 /* For bt_logging_level */
30 #include <babeltrace2/logging.h>
31
32 /* For __BT_FUNC_STATUS_* */
33 #define __BT_FUNC_STATUS_ENABLE
34 #include <babeltrace2/func-status.h>
35 #undef __BT_FUNC_STATUS_ENABLE
36
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 extern
42 bt_query_executor *bt_query_executor_create(void);
43
44 typedef enum bt_query_executor_query_status {
45 BT_QUERY_EXECUTOR_QUERY_STATUS_OK = __BT_FUNC_STATUS_OK,
46 BT_QUERY_EXECUTOR_QUERY_STATUS_AGAIN = __BT_FUNC_STATUS_AGAIN,
47 BT_QUERY_EXECUTOR_QUERY_STATUS_UNSUPPORTED = __BT_FUNC_STATUS_UNSUPPORTED,
48 BT_QUERY_EXECUTOR_QUERY_STATUS_CANCELED = __BT_FUNC_STATUS_CANCELED,
49 BT_QUERY_EXECUTOR_QUERY_STATUS_ERROR = __BT_FUNC_STATUS_ERROR,
50 BT_QUERY_EXECUTOR_QUERY_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
51 BT_QUERY_EXECUTOR_QUERY_STATUS_INVALID_OBJECT = __BT_FUNC_STATUS_INVALID_OBJECT,
52 BT_QUERY_EXECUTOR_QUERY_STATUS_INVALID_PARAMS = __BT_FUNC_STATUS_INVALID_PARAMS,
53 } bt_query_executor_query_status;
54
55 extern
56 bt_query_executor_query_status bt_query_executor_query(
57 bt_query_executor *query_executor,
58 const bt_component_class *component_class,
59 const char *object, const bt_value *params,
60 bt_logging_level logging_level, const bt_value **result);
61
62 typedef enum bt_query_executor_cancel_status {
63 BT_QUERY_EXECUTOR_CANCEL_STATUS_OK = __BT_FUNC_STATUS_OK,
64 } bt_query_executor_cancel_status;
65
66 extern
67 bt_query_executor_cancel_status bt_query_executor_cancel(
68 bt_query_executor *query_executor);
69
70 #ifdef __cplusplus
71 }
72 #endif
73
74 #include <babeltrace2/undef-func-status.h>
75
76 #endif /* BABELTRACE_GRAPH_QUERY_EXECUTOR_H */
This page took 0.032162 seconds and 4 git commands to generate.