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