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