src/bindings/python/bt2/bt2/native_bt_query_exec.i

   1 /*
   2  * The MIT License (MIT)
   3  *
   4  * Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24
  25 /* From query-executor-const.h */
  26
  27 typedef enum bt_query_executor_status {
  28         BT_QUERY_EXECUTOR_STATUS_OK = 0,
  29         BT_QUERY_EXECUTOR_STATUS_AGAIN = 11,
  30         BT_QUERY_EXECUTOR_STATUS_UNSUPPORTED = 95,
  31         BT_QUERY_EXECUTOR_STATUS_CANCELED = 125,
  32         BT_QUERY_EXECUTOR_STATUS_ERROR = -1,
  33         BT_QUERY_EXECUTOR_STATUS_NOMEM = -12,
  34         BT_QUERY_EXECUTOR_STATUS_INVALID_OBJECT = -23,
  35         BT_QUERY_EXECUTOR_STATUS_INVALID_PARAMS = -24,
  36 } bt_query_executor_status;
  37
  38 extern
  39 bt_bool bt_query_executor_is_canceled(
  40                 const bt_query_executor *query_executor);
  41
  42 extern void bt_query_executor_get_ref(
  43                 const bt_query_executor *query_executor);
  44
  45 extern void bt_query_executor_put_ref(
  46                 const bt_query_executor *query_executor);
  47
  48 /* From query-executor.h */
  49
  50 extern
  51 bt_query_executor *bt_query_executor_create(void);
  52
  53 extern
  54 bt_query_executor_status bt_query_executor_query(
  55                 bt_query_executor *query_executor,
  56                 const bt_component_class *component_class,
  57                 const char *object, const bt_value *params,
  58                 const bt_value **OUT);
  59
  60 extern
  61 bt_query_executor_status bt_query_executor_cancel(
  62                 bt_query_executor *query_executor);