query-executor.h

/*
 * SPDX-License-Identifier: MIT
 *
 * Copyright (C) 2010-2019 EfficiOS Inc. and Linux Foundation
 */
 
#ifndef BABELTRACE2_GRAPH_QUERY_EXECUTOR_H
#define BABELTRACE2_GRAPH_QUERY_EXECUTOR_H
 
/* IWYU pragma: private, include <babeltrace2/babeltrace.h> */
 
#ifndef __BT_IN_BABELTRACE_H
# error "Please include <babeltrace2/babeltrace.h> instead."
#endif
 
#include <babeltrace2/types.h>
#include <babeltrace2/logging.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
extern
bt_query_executor *bt_query_executor_create(
        const bt_component_class *component_class,
        const char *object_name, const bt_value *params)
        __BT_NOEXCEPT;
 
extern
bt_query_executor *bt_query_executor_create_with_method_data(
        const bt_component_class *component_class,
        const char *object_name, const bt_value *params,
        void *method_data) __BT_NOEXCEPT;
 
typedef enum bt_query_executor_query_status {
    BT_QUERY_EXECUTOR_QUERY_STATUS_OK       = __BT_FUNC_STATUS_OK,
 
    BT_QUERY_EXECUTOR_QUERY_STATUS_UNKNOWN_OBJECT   = __BT_FUNC_STATUS_UNKNOWN_OBJECT,
 
    BT_QUERY_EXECUTOR_QUERY_STATUS_AGAIN        = __BT_FUNC_STATUS_AGAIN,
 
    BT_QUERY_EXECUTOR_QUERY_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
 
    BT_QUERY_EXECUTOR_QUERY_STATUS_ERROR        = __BT_FUNC_STATUS_ERROR,
} bt_query_executor_query_status;
 
extern
bt_query_executor_query_status bt_query_executor_query(
        bt_query_executor *query_executor, const bt_value **result)
        __BT_NOEXCEPT;
 
typedef enum bt_query_executor_set_logging_level_status {
    BT_QUERY_EXECUTOR_SET_LOGGING_LEVEL_STATUS_OK   = __BT_FUNC_STATUS_OK,
} bt_query_executor_set_logging_level_status;
 
extern bt_query_executor_set_logging_level_status
bt_query_executor_set_logging_level(bt_query_executor *query_executor,
        bt_logging_level logging_level) __BT_NOEXCEPT;
 
extern bt_logging_level bt_query_executor_get_logging_level(
        const bt_query_executor *query_executor) __BT_NOEXCEPT;
 
typedef enum bt_query_executor_add_interrupter_status {
    BT_QUERY_EXECUTOR_ADD_INTERRUPTER_STATUS_OK     = __BT_FUNC_STATUS_OK,
 
    BT_QUERY_EXECUTOR_ADD_INTERRUPTER_STATUS_MEMORY_ERROR   = __BT_FUNC_STATUS_MEMORY_ERROR,
} bt_query_executor_add_interrupter_status;
 
extern bt_query_executor_add_interrupter_status
bt_query_executor_add_interrupter(bt_query_executor *query_executor,
        const bt_interrupter *interrupter) __BT_NOEXCEPT;
 
extern bt_interrupter *bt_query_executor_borrow_default_interrupter(
        bt_query_executor *query_executor) __BT_NOEXCEPT;
 
extern bt_bool bt_query_executor_is_interrupted(
        const bt_query_executor *query_executor) __BT_NOEXCEPT;
 
extern void bt_query_executor_get_ref(const bt_query_executor *query_executor)
        __BT_NOEXCEPT;
 
extern void bt_query_executor_put_ref(const bt_query_executor *query_executor)
        __BT_NOEXCEPT;
 
#define BT_QUERY_EXECUTOR_PUT_REF_AND_RESET(_query_executor)    \
    do {                            \
        bt_query_executor_put_ref(_query_executor); \
        (_query_executor) = NULL;           \
    } while (0)
 
#define BT_QUERY_EXECUTOR_MOVE_REF(_dst, _src)      \
    do {                        \
        bt_query_executor_put_ref(_dst);    \
        (_dst) = (_src);            \
        (_src) = NULL;              \
    } while (0)
 
#ifdef __cplusplus
}
#endif
 
#endif /* BABELTRACE2_GRAPH_QUERY_EXECUTOR_H */