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_init_method_status
  48 (*bt_component_class_filter_init_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_message_iterator_init_method_status
  57 (*bt_component_class_filter_message_iterator_init_method)(
  58                 bt_self_message_iterator *message_iterator,
  59                 bt_self_component_filter *self_component,
  60                 bt_self_component_port_output *port);
  61
  62 typedef void
  63 (*bt_component_class_filter_message_iterator_finalize_method)(
  64                 bt_self_message_iterator *message_iterator);
  65
  66 typedef bt_component_class_message_iterator_next_method_status
  67 (*bt_component_class_filter_message_iterator_next_method)(
  68                 bt_self_message_iterator *message_iterator,
  69                 bt_message_array_const msgs, uint64_t capacity,
  70                 uint64_t *count);
  71
  72 typedef bt_component_class_message_iterator_seek_ns_from_origin_method_status
  73 (*bt_component_class_filter_message_iterator_seek_ns_from_origin_method)(
  74                 bt_self_message_iterator *message_iterator,
  75                 int64_t ns_from_origin);
  76
  77 typedef bt_component_class_message_iterator_seek_beginning_method_status
  78 (*bt_component_class_filter_message_iterator_seek_beginning_method)(
  79                 bt_self_message_iterator *message_iterator);
  80
  81 typedef bt_component_class_message_iterator_can_seek_ns_from_origin_method_status
  82 (*bt_component_class_filter_message_iterator_can_seek_ns_from_origin_method)(
  83                 bt_self_message_iterator *message_iterator,
  84                 int64_t ns_from_origin, bt_bool *can_seek);
  85
  86 typedef bt_component_class_message_iterator_can_seek_beginning_method_status
  87 (*bt_component_class_filter_message_iterator_can_seek_beginning_method)(
  88                 bt_self_message_iterator *message_iterator, bt_bool *can_seek);
  89
  90 typedef bt_component_class_query_method_status
  91 (*bt_component_class_filter_query_method)(
  92                 bt_self_component_class_filter *comp_class,
  93                 bt_private_query_executor *query_executor,
  94                 const char *object, const bt_value *params,
  95                 void *method_data, const bt_value **result);
  96
  97 typedef bt_component_class_port_connected_method_status
  98 (*bt_component_class_filter_input_port_connected_method)(
  99                 bt_self_component_filter *self_component,
 100                 bt_self_component_port_input *self_port,
 101                 const bt_port_output *other_port);
 102
 103 typedef bt_component_class_port_connected_method_status
 104 (*bt_component_class_filter_output_port_connected_method)(
 105                 bt_self_component_filter *self_component,
 106                 bt_self_component_port_output *self_port,
 107                 const bt_port_input *other_port);
 108
 109 static inline
 110 bt_component_class *bt_component_class_filter_as_component_class(
 111                 bt_component_class_filter *comp_cls_filter)
 112 {
 113         return __BT_UPCAST(bt_component_class, comp_cls_filter);
 114 }
 115
 116 extern
 117 bt_component_class_filter *bt_component_class_filter_create(
 118                 const char *name,
 119                 bt_component_class_filter_message_iterator_next_method method);
 120
 121 extern bt_component_class_set_method_status
 122 bt_component_class_filter_set_get_supported_mip_versions_method(
 123                 bt_component_class_filter *comp_class,
 124                 bt_component_class_filter_get_supported_mip_versions_method method);
 125
 126 extern bt_component_class_set_method_status
 127 bt_component_class_filter_set_init_method(
 128                 bt_component_class_filter *comp_class,
 129                 bt_component_class_filter_init_method method);
 130
 131 extern bt_component_class_set_method_status
 132 bt_component_class_filter_set_finalize_method(
 133                 bt_component_class_filter *comp_class,
 134                 bt_component_class_filter_finalize_method method);
 135
 136 extern bt_component_class_set_method_status
 137 bt_component_class_filter_set_input_port_connected_method(
 138                 bt_component_class_filter *comp_class,
 139                 bt_component_class_filter_input_port_connected_method method);
 140
 141 extern bt_component_class_set_method_status
 142 bt_component_class_filter_set_output_port_connected_method(
 143                 bt_component_class_filter *comp_class,
 144                 bt_component_class_filter_output_port_connected_method method);
 145
 146 extern bt_component_class_set_method_status
 147 bt_component_class_filter_set_query_method(
 148                 bt_component_class_filter *comp_class,
 149                 bt_component_class_filter_query_method method);
 150
 151 extern bt_component_class_set_method_status
 152 bt_component_class_filter_set_message_iterator_init_method(
 153                 bt_component_class_filter *comp_class,
 154                 bt_component_class_filter_message_iterator_init_method method);
 155
 156 extern bt_component_class_set_method_status
 157 bt_component_class_filter_set_message_iterator_finalize_method(
 158                 bt_component_class_filter *comp_class,
 159                 bt_component_class_filter_message_iterator_finalize_method method);
 160
 161 extern bt_component_class_set_method_status
 162 bt_component_class_filter_set_message_iterator_seek_ns_from_origin_method(
 163                 bt_component_class_filter *comp_class,
 164                 bt_component_class_filter_message_iterator_seek_ns_from_origin_method method);
 165
 166 extern bt_component_class_set_method_status
 167 bt_component_class_filter_set_message_iterator_seek_beginning_method(
 168                 bt_component_class_filter *comp_class,
 169                 bt_component_class_filter_message_iterator_seek_beginning_method method);
 170
 171 extern bt_component_class_set_method_status
 172 bt_component_class_filter_set_message_iterator_can_seek_ns_from_origin_method(
 173                 bt_component_class_filter *comp_class,
 174                 bt_component_class_filter_message_iterator_can_seek_ns_from_origin_method method);
 175
 176 extern bt_component_class_set_method_status
 177 bt_component_class_filter_set_message_iterator_can_seek_beginning_method(
 178                 bt_component_class_filter *comp_class,
 179                 bt_component_class_filter_message_iterator_can_seek_beginning_method method);
 180
 181 #ifdef __cplusplus
 182 }
 183 #endif
 184
 185 #endif /* BABELTRACE2_GRAPH_COMPONENT_CLASS_FILTER_H */