| 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 | /* Types */ |
| 26 | struct bt_query_executor; |
| 27 | |
| 28 | /* Query status */ |
| 29 | enum bt_query_status { |
| 30 | BT_QUERY_STATUS_OK = 0, |
| 31 | BT_QUERY_STATUS_AGAIN = 11, |
| 32 | BT_QUERY_STATUS_EXECUTOR_CANCELED = 125, |
| 33 | BT_QUERY_STATUS_ERROR = -1, |
| 34 | BT_QUERY_STATUS_INVALID = -22, |
| 35 | BT_QUERY_STATUS_INVALID_OBJECT = -23, |
| 36 | BT_QUERY_STATUS_INVALID_PARAMS = -24, |
| 37 | BT_QUERY_STATUS_NOMEM = -12, |
| 38 | }; |
| 39 | |
| 40 | /* Functions */ |
| 41 | struct bt_query_executor *bt_query_executor_create(void); |
| 42 | enum bt_query_status bt_query_executor_query( |
| 43 | struct bt_query_executor *query_executor, |
| 44 | struct bt_component_class *component_class, |
| 45 | const char *object, struct bt_value *params, |
| 46 | struct bt_value **BTOUTVALUE); |
| 47 | enum bt_query_status bt_query_executor_cancel( |
| 48 | struct bt_query_executor *query_executor); |
| 49 | int bt_query_executor_is_canceled(struct bt_query_executor *query_executor); |