include/babeltrace2/graph/query-executor.h

   1 #ifndef BABELTRACE2_GRAPH_QUERY_EXECUTOR_H
   2 #define BABELTRACE2_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 #ifndef __BT_IN_BABELTRACE_H
  27 # error "Please include <babeltrace2/babeltrace.h> instead."
  28 #endif
  29
  30 /* For bt_query_executor, bt_component_class, bt_value */
  31 #include <babeltrace2/types.h>
  32
  33 /* For bt_logging_level */
  34 #include <babeltrace2/logging.h>
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 extern
  41 bt_query_executor *bt_query_executor_create(void);
  42
  43 typedef enum bt_query_executor_query_status {
  44         BT_QUERY_EXECUTOR_QUERY_STATUS_OK               = __BT_FUNC_STATUS_OK,
  45         BT_QUERY_EXECUTOR_QUERY_STATUS_AGAIN            = __BT_FUNC_STATUS_AGAIN,
  46         BT_QUERY_EXECUTOR_QUERY_STATUS_UNSUPPORTED      = __BT_FUNC_STATUS_UNSUPPORTED,
  47         BT_QUERY_EXECUTOR_QUERY_STATUS_CANCELED         = __BT_FUNC_STATUS_CANCELED,
  48         BT_QUERY_EXECUTOR_QUERY_STATUS_ERROR            = __BT_FUNC_STATUS_ERROR,
  49         BT_QUERY_EXECUTOR_QUERY_STATUS_MEMORY_ERROR     = __BT_FUNC_STATUS_MEMORY_ERROR,
  50         BT_QUERY_EXECUTOR_QUERY_STATUS_INVALID_OBJECT   = __BT_FUNC_STATUS_INVALID_OBJECT,
  51         BT_QUERY_EXECUTOR_QUERY_STATUS_INVALID_PARAMS   = __BT_FUNC_STATUS_INVALID_PARAMS,
  52 } bt_query_executor_query_status;
  53
  54 extern
  55 bt_query_executor_query_status bt_query_executor_query(
  56                 bt_query_executor *query_executor,
  57                 const bt_component_class *component_class,
  58                 const char *object, const bt_value *params,
  59                 bt_logging_level logging_level, const bt_value **result);
  60
  61 typedef enum bt_query_executor_cancel_status {
  62         BT_QUERY_EXECUTOR_CANCEL_STATUS_OK      = __BT_FUNC_STATUS_OK,
  63 } bt_query_executor_cancel_status;
  64
  65 extern
  66 bt_query_executor_cancel_status bt_query_executor_cancel(
  67                 bt_query_executor *query_executor);
  68
  69 #ifdef __cplusplus
  70 }
  71 #endif
  72
  73 #endif /* BABELTRACE2_GRAPH_QUERY_EXECUTOR_H */