1 #ifndef BABELTRACE2_GRAPH_PRIVATE_QUERY_EXECUTOR_H
2 #define BABELTRACE2_GRAPH_PRIVATE_QUERY_EXECUTOR_H
5 * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
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:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
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
26 #ifndef __BT_IN_BABELTRACE_H
27 # error "Please include <babeltrace2/babeltrace.h> instead."
30 #include <babeltrace2/types.h>
37 @defgroup api-priv-qexec Private query executor
38 @ingroup api-comp-cls-dev
41 Private view of a \bt_qexec for a \bt_comp_cls
42 \ref api-comp-cls-dev-meth-query "query method".
44 A <strong><em>private query executor</em></strong> is a private view,
45 from within a \bt_comp_cls
46 \ref api-comp-cls-dev-meth-query "query method", of a
49 A query method receives a private query executor as its
50 \bt_p{query_executor} parameter.
52 As of \bt_name_version_min_maj, this module only offers the
53 bt_private_query_executor_as_query_executor_const() function to
54 \ref api-fund-c-typing "upcast" a private query executor to a
55 \c const query executor. You need this to get the query executor's
56 \ref api-qexec-prop-log-lvl "logging level".
65 @typedef struct bt_private_query_executor bt_private_query_executor;
68 Private query executor.
80 \ref api-fund-c-typing "Upcasts" the private query executor
81 \bt_p{query_executor} to the public #bt_query_executor type.
83 @param[in] query_executor
85 Private query executor to upcast.
91 \bt_p{query_executor} as a public query executor.
94 const bt_query_executor
*
95 bt_private_query_executor_as_query_executor_const(
96 bt_private_query_executor
*query_executor
)
98 return __BT_UPCAST_CONST(bt_query_executor
, query_executor
);
109 #endif /* BABELTRACE2_GRAPH_PRIVATE_QUERY_EXECUTOR_H */