include/babeltrace2/graph/component-class-filter.h

   1 #ifndef BABELTRACE2_GRAPH_COMPONENT_CLASS_FILTER_H
   2 #define BABELTRACE2_GRAPH_COMPONENT_CLASS_FILTER_H
   3
   4 /*
   5  * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
   6  *
   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:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  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
  23  * SOFTWARE.
  24  */
  25
  26 #ifndef __BT_IN_BABELTRACE_H
  27 # error "Please include <babeltrace2/babeltrace.h> instead."
  28 #endif
  29
  30 #include <stdint.h>
  31
  32 #include <babeltrace2/graph/component-class.h>
  33 #include <babeltrace2/types.h>
  34 #include <babeltrace2/logging.h>
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 typedef bt_component_class_get_supported_mip_versions_method_status
  41 (*bt_component_class_filter_get_supported_mip_versions_method)(
  42                 bt_self_component_class_filter *comp_class,
  43                 const bt_value *params, void *init_method_data,
  44                 bt_logging_level log_level,
  45                 bt_integer_range_set_unsigned *supported_versions);
  46
  47 typedef bt_component_class_initialize_method_status
  48 (*bt_component_class_filter_initialize_method)(
  49                 bt_self_component_filter *self_component,
  50                 bt_self_component_filter_configuration *config,
  51                 const bt_value *params, void *init_method_data);
  52
  53 typedef void (*bt_component_class_filter_finalize_method)(
  54                 bt_self_component_filter *self_component);
  55
  56 typedef bt_component_class_query_method_status
  57 (*bt_component_class_filter_query_method)(
  58                 bt_self_component_class_filter *comp_class,
  59                 bt_private_query_executor *query_executor,
  60                 const char *object, const bt_value *params,
  61                 void *method_data, const bt_value **result);
  62
  63 typedef bt_component_class_port_connected_method_status
  64 (*bt_component_class_filter_input_port_connected_method)(
  65                 bt_self_component_filter *self_component,
  66                 bt_self_component_port_input *self_port,
  67                 const bt_port_output *other_port);
  68
  69 typedef bt_component_class_port_connected_method_status
  70 (*bt_component_class_filter_output_port_connected_method)(
  71                 bt_self_component_filter *self_component,
  72                 bt_self_component_port_output *self_port,
  73                 const bt_port_input *other_port);
  74
  75 static inline
  76 bt_component_class *bt_component_class_filter_as_component_class(
  77                 bt_component_class_filter *comp_cls_filter)
  78 {
  79         return __BT_UPCAST(bt_component_class, comp_cls_filter);
  80 }
  81
  82 extern
  83 bt_component_class_filter *bt_component_class_filter_create(
  84                 const char *name,
  85                 bt_message_iterator_class *message_iterator_class);
  86
  87 extern bt_component_class_set_method_status
  88 bt_component_class_filter_set_get_supported_mip_versions_method(
  89                 bt_component_class_filter *comp_class,
  90                 bt_component_class_filter_get_supported_mip_versions_method method);
  91
  92 extern bt_component_class_set_method_status
  93 bt_component_class_filter_set_initialize_method(
  94                 bt_component_class_filter *comp_class,
  95                 bt_component_class_filter_initialize_method method);
  96
  97 extern bt_component_class_set_method_status
  98 bt_component_class_filter_set_finalize_method(
  99                 bt_component_class_filter *comp_class,
 100                 bt_component_class_filter_finalize_method method);
 101
 102 extern bt_component_class_set_method_status
 103 bt_component_class_filter_set_input_port_connected_method(
 104                 bt_component_class_filter *comp_class,
 105                 bt_component_class_filter_input_port_connected_method method);
 106
 107 extern bt_component_class_set_method_status
 108 bt_component_class_filter_set_output_port_connected_method(
 109                 bt_component_class_filter *comp_class,
 110                 bt_component_class_filter_output_port_connected_method method);
 111
 112 extern bt_component_class_set_method_status
 113 bt_component_class_filter_set_query_method(
 114                 bt_component_class_filter *comp_class,
 115                 bt_component_class_filter_query_method method);
 116
 117 #ifdef __cplusplus
 118 }
 119 #endif
 120
 121 #endif /* BABELTRACE2_GRAPH_COMPONENT_CLASS_FILTER_H */