component-class-dev.h

/*
 * SPDX-License-Identifier: MIT
 *
 * Copyright (C) 2010-2019 EfficiOS Inc. and Linux Foundation
 */
 
#ifndef BABELTRACE2_GRAPH_COMPONENT_CLASS_DEV_H
#define BABELTRACE2_GRAPH_COMPONENT_CLASS_DEV_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
 
typedef enum bt_component_class_sink_consume_method_status {
    BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_OK        = __BT_FUNC_STATUS_OK,
 
    BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_END       = __BT_FUNC_STATUS_END,
 
    BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_AGAIN     = __BT_FUNC_STATUS_AGAIN,
 
    BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_MEMORY_ERROR  = __BT_FUNC_STATUS_MEMORY_ERROR,
 
    BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_ERROR     = __BT_FUNC_STATUS_ERROR,
} bt_component_class_sink_consume_method_status;
 
typedef bt_component_class_sink_consume_method_status
(*bt_component_class_sink_consume_method)(
        bt_self_component_sink *self_component);
 
typedef void (*bt_component_class_source_finalize_method)(
        bt_self_component_source *self_component);
 
typedef void (*bt_component_class_filter_finalize_method)(
        bt_self_component_filter *self_component);
 
typedef void (*bt_component_class_sink_finalize_method)(
        bt_self_component_sink *self_component);
 
typedef enum bt_component_class_get_supported_mip_versions_method_status {
    BT_COMPONENT_CLASS_GET_SUPPORTED_MIP_VERSIONS_METHOD_STATUS_OK          = __BT_FUNC_STATUS_OK,
 
    BT_COMPONENT_CLASS_GET_SUPPORTED_MIP_VERSIONS_METHOD_STATUS_MEMORY_ERROR    = __BT_FUNC_STATUS_MEMORY_ERROR,
 
    BT_COMPONENT_CLASS_GET_SUPPORTED_MIP_VERSIONS_METHOD_STATUS_ERROR       = __BT_FUNC_STATUS_ERROR,
} bt_component_class_get_supported_mip_versions_method_status;
 
typedef bt_component_class_get_supported_mip_versions_method_status
(*bt_component_class_source_get_supported_mip_versions_method)(
        bt_self_component_class_source *self_component_class,
        const bt_value *params, void *initialize_method_data,
        bt_logging_level logging_level,
        bt_integer_range_set_unsigned *supported_versions);
 
typedef bt_component_class_get_supported_mip_versions_method_status
(*bt_component_class_filter_get_supported_mip_versions_method)(
        bt_self_component_class_filter *self_component_class,
        const bt_value *params, void *initialize_method_data,
        bt_logging_level logging_level,
        bt_integer_range_set_unsigned *supported_versions);
 
typedef bt_component_class_get_supported_mip_versions_method_status
(*bt_component_class_sink_get_supported_mip_versions_method)(
        bt_self_component_class_sink *self_component_class,
        const bt_value *params, void *initialize_method_data,
        bt_logging_level logging_level,
        bt_integer_range_set_unsigned *supported_versions);
 
typedef enum bt_component_class_sink_graph_is_configured_method_status {
    BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_OK        = __BT_FUNC_STATUS_OK,
 
    BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_MEMORY_ERROR  = __BT_FUNC_STATUS_MEMORY_ERROR,
 
    BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_ERROR     = __BT_FUNC_STATUS_ERROR,
} bt_component_class_sink_graph_is_configured_method_status;
 
typedef bt_component_class_sink_graph_is_configured_method_status
(*bt_component_class_sink_graph_is_configured_method)(
        bt_self_component_sink *self_component);
 
typedef enum bt_component_class_initialize_method_status {
    BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK          = __BT_FUNC_STATUS_OK,
 
    BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR    = __BT_FUNC_STATUS_MEMORY_ERROR,
 
    BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR       = __BT_FUNC_STATUS_ERROR,
} bt_component_class_initialize_method_status;
 
typedef bt_component_class_initialize_method_status
(*bt_component_class_source_initialize_method)(
        bt_self_component_source *self_component,
        bt_self_component_source_configuration *configuration,
        const bt_value *params, void *initialize_method_data);
 
typedef bt_component_class_initialize_method_status
(*bt_component_class_filter_initialize_method)(
        bt_self_component_filter *self_component,
        bt_self_component_filter_configuration *configuration,
        const bt_value *params, void *initialize_method_data);
 
typedef bt_component_class_initialize_method_status
(*bt_component_class_sink_initialize_method)(
        bt_self_component_sink *self_component,
        bt_self_component_sink_configuration *configuration,
        const bt_value *params, void *initialize_method_data);
 
typedef enum bt_component_class_port_connected_method_status {
    BT_COMPONENT_CLASS_PORT_CONNECTED_METHOD_STATUS_OK      = __BT_FUNC_STATUS_OK,
 
    BT_COMPONENT_CLASS_PORT_CONNECTED_METHOD_STATUS_MEMORY_ERROR    = __BT_FUNC_STATUS_MEMORY_ERROR,
 
    BT_COMPONENT_CLASS_PORT_CONNECTED_METHOD_STATUS_ERROR       = __BT_FUNC_STATUS_ERROR,
} bt_component_class_port_connected_method_status;
 
typedef bt_component_class_port_connected_method_status
(*bt_component_class_source_output_port_connected_method)(
        bt_self_component_source *self_component,
        bt_self_component_port_output *self_port,
        const bt_port_input *other_port);
 
typedef bt_component_class_port_connected_method_status
(*bt_component_class_filter_input_port_connected_method)(
        bt_self_component_filter *self_component,
        bt_self_component_port_input *self_port,
        const bt_port_output *other_port);
 
typedef bt_component_class_port_connected_method_status
(*bt_component_class_filter_output_port_connected_method)(
        bt_self_component_filter *self_component,
        bt_self_component_port_output *self_port,
        const bt_port_input *other_port);
 
typedef bt_component_class_port_connected_method_status
(*bt_component_class_sink_input_port_connected_method)(
        bt_self_component_sink *self_component,
        bt_self_component_port_input *self_port,
        const bt_port_output *other_port);
 
typedef enum bt_component_class_query_method_status {
    BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK       = __BT_FUNC_STATUS_OK,
 
    BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT   = __BT_FUNC_STATUS_UNKNOWN_OBJECT,
 
    BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_AGAIN        = __BT_FUNC_STATUS_AGAIN,
 
    BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
 
    BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR        = __BT_FUNC_STATUS_ERROR,
} bt_component_class_query_method_status;
 
typedef bt_component_class_query_method_status
(*bt_component_class_source_query_method)(
        bt_self_component_class_source *self_component_class,
        bt_private_query_executor *query_executor,
        const char *object_name, const bt_value *params,
        void *method_data, const bt_value **result);
 
typedef bt_component_class_query_method_status
(*bt_component_class_filter_query_method)(
        bt_self_component_class_filter *self_component_class,
        bt_private_query_executor *query_executor,
        const char *object_name, const bt_value *params,
        void *method_data, const bt_value **result);
 
typedef bt_component_class_query_method_status
(*bt_component_class_sink_query_method)(
        bt_self_component_class_sink *self_component_class,
        bt_private_query_executor *query_executor,
        const char *object_name, const bt_value *params,
        void *method_data, const bt_value **result);
 
extern
bt_component_class_source *bt_component_class_source_create(
        const char *name,
        bt_message_iterator_class *message_iterator_class)
        __BT_NOEXCEPT;
 
extern
bt_component_class_filter *bt_component_class_filter_create(
        const char *name,
        bt_message_iterator_class *message_iterator_class)
        __BT_NOEXCEPT;
 
extern
bt_component_class_sink *bt_component_class_sink_create(
        const char *name,
        bt_component_class_sink_consume_method consume_method)
        __BT_NOEXCEPT;
 
typedef enum bt_component_class_set_description_status {
    BT_COMPONENT_CLASS_SET_DESCRIPTION_STATUS_OK        = __BT_FUNC_STATUS_OK,
 
    BT_COMPONENT_CLASS_SET_DESCRIPTION_STATUS_MEMORY_ERROR  = __BT_FUNC_STATUS_MEMORY_ERROR,
} bt_component_class_set_description_status;
 
extern bt_component_class_set_description_status
bt_component_class_set_description(bt_component_class *component_class,
        const char *description) __BT_NOEXCEPT;
 
typedef enum bt_component_class_set_help_status {
    BT_COMPONENT_CLASS_SET_HELP_STATUS_OK       = __BT_FUNC_STATUS_OK,
 
    BT_COMPONENT_CLASS_SET_HELP_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
} bt_component_class_set_help_status;
 
extern bt_component_class_set_help_status bt_component_class_set_help(
        bt_component_class *component_class,
        const char *help_text) __BT_NOEXCEPT;
 
typedef enum bt_component_class_set_method_status {
    BT_COMPONENT_CLASS_SET_METHOD_STATUS_OK =   __BT_FUNC_STATUS_OK,
} bt_component_class_set_method_status;
 
extern bt_component_class_set_method_status
bt_component_class_source_set_finalize_method(
        bt_component_class_source *component_class,
        bt_component_class_source_finalize_method method) __BT_NOEXCEPT;
 
extern bt_component_class_set_method_status
bt_component_class_filter_set_finalize_method(
        bt_component_class_filter *component_class,
        bt_component_class_filter_finalize_method method) __BT_NOEXCEPT;
 
extern
bt_component_class_set_method_status
bt_component_class_sink_set_finalize_method(
        bt_component_class_sink *component_class,
        bt_component_class_sink_finalize_method method) __BT_NOEXCEPT;
 
extern bt_component_class_set_method_status
bt_component_class_source_set_get_supported_mip_versions_method(
        bt_component_class_source *component_class,
        bt_component_class_source_get_supported_mip_versions_method method)
        __BT_NOEXCEPT;
 
extern bt_component_class_set_method_status
bt_component_class_filter_set_get_supported_mip_versions_method(
        bt_component_class_filter *component_class,
        bt_component_class_filter_get_supported_mip_versions_method method)
        __BT_NOEXCEPT;
 
extern bt_component_class_set_method_status
bt_component_class_sink_set_get_supported_mip_versions_method(
        bt_component_class_sink *component_class,
        bt_component_class_sink_get_supported_mip_versions_method method)
        __BT_NOEXCEPT;
 
extern
bt_component_class_set_method_status
bt_component_class_sink_set_graph_is_configured_method(
        bt_component_class_sink *component_class,
        bt_component_class_sink_graph_is_configured_method method)
        __BT_NOEXCEPT;
 
extern bt_component_class_set_method_status
bt_component_class_source_set_initialize_method(
        bt_component_class_source *component_class,
        bt_component_class_source_initialize_method method)
        __BT_NOEXCEPT;
 
extern bt_component_class_set_method_status
bt_component_class_filter_set_initialize_method(
        bt_component_class_filter *component_class,
        bt_component_class_filter_initialize_method method)
        __BT_NOEXCEPT;
 
extern
bt_component_class_set_method_status
bt_component_class_sink_set_initialize_method(
        bt_component_class_sink *component_class,
        bt_component_class_sink_initialize_method method) __BT_NOEXCEPT;
 
extern bt_component_class_set_method_status
bt_component_class_source_set_output_port_connected_method(
        bt_component_class_source *component_class,
        bt_component_class_source_output_port_connected_method method)
        __BT_NOEXCEPT;
 
extern bt_component_class_set_method_status
bt_component_class_filter_set_input_port_connected_method(
        bt_component_class_filter *component_class,
        bt_component_class_filter_input_port_connected_method method)
        __BT_NOEXCEPT;
 
extern bt_component_class_set_method_status
bt_component_class_filter_set_output_port_connected_method(
        bt_component_class_filter *component_class,
        bt_component_class_filter_output_port_connected_method method)
        __BT_NOEXCEPT;
 
extern
bt_component_class_set_method_status
bt_component_class_sink_set_input_port_connected_method(
        bt_component_class_sink *component_class,
        bt_component_class_sink_input_port_connected_method method)
        __BT_NOEXCEPT;
 
extern bt_component_class_set_method_status
bt_component_class_source_set_query_method(
        bt_component_class_source *component_class,
        bt_component_class_source_query_method method) __BT_NOEXCEPT;
 
extern bt_component_class_set_method_status
bt_component_class_filter_set_query_method(
        bt_component_class_filter *component_class,
        bt_component_class_filter_query_method method) __BT_NOEXCEPT;
 
extern
bt_component_class_set_method_status
bt_component_class_sink_set_query_method(
        bt_component_class_sink *component_class,
        bt_component_class_sink_query_method method) __BT_NOEXCEPT;
 
static inline
bt_component_class *bt_component_class_source_as_component_class(
        bt_component_class_source *component_class) __BT_NOEXCEPT
{
    return __BT_UPCAST(bt_component_class, component_class);
}
 
static inline
bt_component_class *bt_component_class_filter_as_component_class(
        bt_component_class_filter *component_class) __BT_NOEXCEPT
{
    return __BT_UPCAST(bt_component_class, component_class);
}
 
static inline
bt_component_class *bt_component_class_sink_as_component_class(
        bt_component_class_sink *component_class) __BT_NOEXCEPT
{
    return __BT_UPCAST(bt_component_class, component_class);
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* BABELTRACE2_GRAPH_COMPONENT_CLASS_DEV_H */