include/babeltrace2/graph/query-executor.h

   1 #ifndef BABELTRACE2_GRAPH_QUERY_EXECUTOR_H
   2 #define BABELTRACE2_GRAPH_QUERY_EXECUTOR_H
   3
   4 /*
   5  * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
   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 #include <babeltrace2/types.h>
  31 #include <babeltrace2/logging.h>
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 extern
  38 bt_query_executor *bt_query_executor_create(void);
  39
  40 typedef enum bt_query_executor_query_status {
  41         BT_QUERY_EXECUTOR_QUERY_STATUS_OK               = __BT_FUNC_STATUS_OK,
  42         BT_QUERY_EXECUTOR_QUERY_STATUS_AGAIN            = __BT_FUNC_STATUS_AGAIN,
  43         BT_QUERY_EXECUTOR_QUERY_STATUS_ERROR            = __BT_FUNC_STATUS_ERROR,
  44         BT_QUERY_EXECUTOR_QUERY_STATUS_MEMORY_ERROR     = __BT_FUNC_STATUS_MEMORY_ERROR,
  45         BT_QUERY_EXECUTOR_QUERY_STATUS_INVALID_OBJECT   = __BT_FUNC_STATUS_INVALID_OBJECT,
  46         BT_QUERY_EXECUTOR_QUERY_STATUS_INVALID_PARAMS   = __BT_FUNC_STATUS_INVALID_PARAMS,
  47 } bt_query_executor_query_status;
  48
  49 extern
  50 bt_query_executor_query_status bt_query_executor_query(
  51                 bt_query_executor *query_executor,
  52                 const bt_component_class *component_class,
  53                 const char *object, const bt_value *params,
  54                 bt_logging_level logging_level, const bt_value **result);
  55
  56 typedef enum bt_query_executor_add_interrupter_status {
  57         BT_QUERY_EXECUTOR_ADD_INTERRUPTER_STATUS_OK     = __BT_FUNC_STATUS_OK,
  58         BT_QUERY_EXECUTOR_ADD_INTERRUPTER_MEMORY_ERROR  = __BT_FUNC_STATUS_MEMORY_ERROR,
  59 } bt_query_executor_add_interrupter_status;
  60
  61 extern bt_query_executor_add_interrupter_status
  62 bt_query_executor_add_interrupter(bt_query_executor *query_executor,
  63                 const bt_interrupter *interrupter);
  64
  65 extern void bt_query_executor_interrupt(bt_query_executor *query_executor);
  66
  67 #ifdef __cplusplus
  68 }
  69 #endif
  70
  71 #endif /* BABELTRACE2_GRAPH_QUERY_EXECUTOR_H */