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

   1 #ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_FILTER_H
   2 #define BABELTRACE_GRAPH_COMPONENT_CLASS_FILTER_H
   3
   4 /*
   5  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   6  * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a copy
   9  * of this software and associated documentation files (the "Software"), to deal
  10  * in the Software without restriction, including without limitation the rights
  11  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12  * copies of the Software, and to permit persons to whom the Software is
  13  * furnished to do so, subject to the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included in
  16  * all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  24  * SOFTWARE.
  25  */
  26
  27 #include <stdint.h>
  28
  29 /* For bt_component_class_*_status */
  30 #include <babeltrace2/graph/component-class.h>
  31
  32 /*
  33  * For bt_component_class, bt_component_class_filter, bt_port_input,
  34  * bt_port_output, bt_query_executor, bt_self_component_class_filter,
  35  * bt_self_component_filter, bt_self_component_port_input,
  36  * bt_self_component_port_output, bt_value, bt_message_array_const,
  37  * bt_bool, bt_self_message_iterator, __BT_UPCAST
  38  */
  39 #include <babeltrace2/types.h>
  40
  41 /* For bt_logging_level */
  42 #include <babeltrace2/logging.h>
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 typedef bt_component_class_init_method_status
  49 (*bt_component_class_filter_init_method)(
  50                 bt_self_component_filter *self_component,
  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_bool
  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);
  85
  86 typedef bt_bool
  87 (*bt_component_class_filter_message_iterator_can_seek_beginning_method)(
  88                 bt_self_message_iterator *message_iterator);
  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                 const bt_query_executor *query_executor,
  94                 const char *object, const bt_value *params,
  95                 bt_logging_level logging_level, 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_init_method(
 123                 bt_component_class_filter *comp_class,
 124                 bt_component_class_filter_init_method method);
 125
 126 extern bt_component_class_set_method_status
 127 bt_component_class_filter_set_finalize_method(
 128                 bt_component_class_filter *comp_class,
 129                 bt_component_class_filter_finalize_method method);
 130
 131 extern bt_component_class_set_method_status
 132 bt_component_class_filter_set_input_port_connected_method(
 133                 bt_component_class_filter *comp_class,
 134                 bt_component_class_filter_input_port_connected_method method);
 135
 136 extern bt_component_class_set_method_status
 137 bt_component_class_filter_set_output_port_connected_method(
 138                 bt_component_class_filter *comp_class,
 139                 bt_component_class_filter_output_port_connected_method method);
 140
 141 extern bt_component_class_set_method_status
 142 bt_component_class_filter_set_query_method(
 143                 bt_component_class_filter *comp_class,
 144                 bt_component_class_filter_query_method method);
 145
 146 extern bt_component_class_set_method_status
 147 bt_component_class_filter_set_message_iterator_init_method(
 148                 bt_component_class_filter *comp_class,
 149                 bt_component_class_filter_message_iterator_init_method method);
 150
 151 extern bt_component_class_set_method_status
 152 bt_component_class_filter_set_message_iterator_finalize_method(
 153                 bt_component_class_filter *comp_class,
 154                 bt_component_class_filter_message_iterator_finalize_method method);
 155
 156 extern bt_component_class_set_method_status
 157 bt_component_class_filter_set_message_iterator_seek_ns_from_origin_method(
 158                 bt_component_class_filter *comp_class,
 159                 bt_component_class_filter_message_iterator_seek_ns_from_origin_method method);
 160
 161 extern bt_component_class_set_method_status
 162 bt_component_class_filter_set_message_iterator_seek_beginning_method(
 163                 bt_component_class_filter *comp_class,
 164                 bt_component_class_filter_message_iterator_seek_beginning_method method);
 165
 166 extern bt_component_class_set_method_status
 167 bt_component_class_filter_set_message_iterator_can_seek_ns_from_origin_method(
 168                 bt_component_class_filter *comp_class,
 169                 bt_component_class_filter_message_iterator_can_seek_ns_from_origin_method method);
 170
 171 extern bt_component_class_set_method_status
 172 bt_component_class_filter_set_message_iterator_can_seek_beginning_method(
 173                 bt_component_class_filter *comp_class,
 174                 bt_component_class_filter_message_iterator_can_seek_beginning_method method);
 175
 176 #ifdef __cplusplus
 177 }
 178 #endif
 179
 180 #endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_FILTER_H */