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 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 #ifndef __BT_IN_BABELTRACE_H
  28 # error "Please include <babeltrace2/babeltrace.h> instead."
  29 #endif
  30
  31 #include <stdint.h>
  32
  33 #include <babeltrace2/graph/component-class.h>
  34 #include <babeltrace2/types.h>
  35 #include <babeltrace2/logging.h>
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 typedef bt_component_class_init_method_status
  42 (*bt_component_class_filter_init_method)(
  43                 bt_self_component_filter *self_component,
  44                 const bt_value *params, void *init_method_data);
  45
  46 typedef void (*bt_component_class_filter_finalize_method)(
  47                 bt_self_component_filter *self_component);
  48
  49 typedef bt_component_class_message_iterator_init_method_status
  50 (*bt_component_class_filter_message_iterator_init_method)(
  51                 bt_self_message_iterator *message_iterator,
  52                 bt_self_component_filter *self_component,
  53                 bt_self_component_port_output *port);
  54
  55 typedef void
  56 (*bt_component_class_filter_message_iterator_finalize_method)(
  57                 bt_self_message_iterator *message_iterator);
  58
  59 typedef bt_component_class_message_iterator_next_method_status
  60 (*bt_component_class_filter_message_iterator_next_method)(
  61                 bt_self_message_iterator *message_iterator,
  62                 bt_message_array_const msgs, uint64_t capacity,
  63                 uint64_t *count);
  64
  65 typedef bt_component_class_message_iterator_seek_ns_from_origin_method_status
  66 (*bt_component_class_filter_message_iterator_seek_ns_from_origin_method)(
  67                 bt_self_message_iterator *message_iterator,
  68                 int64_t ns_from_origin);
  69
  70 typedef bt_component_class_message_iterator_seek_beginning_method_status
  71 (*bt_component_class_filter_message_iterator_seek_beginning_method)(
  72                 bt_self_message_iterator *message_iterator);
  73
  74 typedef bt_bool
  75 (*bt_component_class_filter_message_iterator_can_seek_ns_from_origin_method)(
  76                 bt_self_message_iterator *message_iterator,
  77                 int64_t ns_from_origin);
  78
  79 typedef bt_bool
  80 (*bt_component_class_filter_message_iterator_can_seek_beginning_method)(
  81                 bt_self_message_iterator *message_iterator);
  82
  83 typedef bt_component_class_query_method_status
  84 (*bt_component_class_filter_query_method)(
  85                 bt_self_component_class_filter *comp_class,
  86                 const bt_query_executor *query_executor,
  87                 const char *object, const bt_value *params,
  88                 bt_logging_level logging_level, const bt_value **result);
  89
  90 typedef bt_component_class_port_connected_method_status
  91 (*bt_component_class_filter_input_port_connected_method)(
  92                 bt_self_component_filter *self_component,
  93                 bt_self_component_port_input *self_port,
  94                 const bt_port_output *other_port);
  95
  96 typedef bt_component_class_port_connected_method_status
  97 (*bt_component_class_filter_output_port_connected_method)(
  98                 bt_self_component_filter *self_component,
  99                 bt_self_component_port_output *self_port,
 100                 const bt_port_input *other_port);
 101
 102 static inline
 103 bt_component_class *bt_component_class_filter_as_component_class(
 104                 bt_component_class_filter *comp_cls_filter)
 105 {
 106         return __BT_UPCAST(bt_component_class, comp_cls_filter);
 107 }
 108
 109 extern
 110 bt_component_class_filter *bt_component_class_filter_create(
 111                 const char *name,
 112                 bt_component_class_filter_message_iterator_next_method method);
 113
 114 extern bt_component_class_set_method_status
 115 bt_component_class_filter_set_init_method(
 116                 bt_component_class_filter *comp_class,
 117                 bt_component_class_filter_init_method method);
 118
 119 extern bt_component_class_set_method_status
 120 bt_component_class_filter_set_finalize_method(
 121                 bt_component_class_filter *comp_class,
 122                 bt_component_class_filter_finalize_method method);
 123
 124 extern bt_component_class_set_method_status
 125 bt_component_class_filter_set_input_port_connected_method(
 126                 bt_component_class_filter *comp_class,
 127                 bt_component_class_filter_input_port_connected_method method);
 128
 129 extern bt_component_class_set_method_status
 130 bt_component_class_filter_set_output_port_connected_method(
 131                 bt_component_class_filter *comp_class,
 132                 bt_component_class_filter_output_port_connected_method method);
 133
 134 extern bt_component_class_set_method_status
 135 bt_component_class_filter_set_query_method(
 136                 bt_component_class_filter *comp_class,
 137                 bt_component_class_filter_query_method method);
 138
 139 extern bt_component_class_set_method_status
 140 bt_component_class_filter_set_message_iterator_init_method(
 141                 bt_component_class_filter *comp_class,
 142                 bt_component_class_filter_message_iterator_init_method method);
 143
 144 extern bt_component_class_set_method_status
 145 bt_component_class_filter_set_message_iterator_finalize_method(
 146                 bt_component_class_filter *comp_class,
 147                 bt_component_class_filter_message_iterator_finalize_method method);
 148
 149 extern bt_component_class_set_method_status
 150 bt_component_class_filter_set_message_iterator_seek_ns_from_origin_method(
 151                 bt_component_class_filter *comp_class,
 152                 bt_component_class_filter_message_iterator_seek_ns_from_origin_method method);
 153
 154 extern bt_component_class_set_method_status
 155 bt_component_class_filter_set_message_iterator_seek_beginning_method(
 156                 bt_component_class_filter *comp_class,
 157                 bt_component_class_filter_message_iterator_seek_beginning_method method);
 158
 159 extern bt_component_class_set_method_status
 160 bt_component_class_filter_set_message_iterator_can_seek_ns_from_origin_method(
 161                 bt_component_class_filter *comp_class,
 162                 bt_component_class_filter_message_iterator_can_seek_ns_from_origin_method method);
 163
 164 extern bt_component_class_set_method_status
 165 bt_component_class_filter_set_message_iterator_can_seek_beginning_method(
 166                 bt_component_class_filter *comp_class,
 167                 bt_component_class_filter_message_iterator_can_seek_beginning_method method);
 168
 169 #ifdef __cplusplus
 170 }
 171 #endif
 172
 173 #endif /* BABELTRACE2_GRAPH_COMPONENT_CLASS_FILTER_H */