include/babeltrace/graph/component-class-sink.h

   1 #ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_SINK_H
   2 #define BABELTRACE_GRAPH_COMPONENT_CLASS_SINK_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_query_status */
  33 #include <babeltrace/graph/component-class.h>
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 struct bt_component_class;
  40 struct bt_component_class_sink;
  41 struct bt_port_output;
  42 struct bt_query_executor;
  43 struct bt_self_component_class_sink;
  44 struct bt_self_component_port_input;
  45 struct bt_self_component_sink;
  46 struct bt_value;
  47
  48 typedef enum bt_self_component_status
  49 (*bt_component_class_sink_init_method)(
  50                 struct bt_self_component_sink *self_component,
  51                 const struct bt_value *params, void *init_method_data);
  52
  53 typedef void (*bt_component_class_sink_finalize_method)(
  54                 struct bt_self_component_sink *self_component);
  55
  56 typedef enum bt_query_status
  57 (*bt_component_class_sink_query_method)(
  58                 struct bt_self_component_class_sink *comp_class,
  59                 const struct bt_query_executor *query_executor,
  60                 const char *object, const struct bt_value *params,
  61                 const struct bt_value **result);
  62
  63 typedef enum bt_self_component_status
  64 (*bt_component_class_sink_accept_input_port_connection_method)(
  65                 struct bt_self_component_sink *self_component,
  66                 struct bt_self_component_port_input *self_port,
  67                 const struct bt_port_output *other_port);
  68
  69 typedef enum bt_self_component_status
  70 (*bt_component_class_sink_input_port_connected_method)(
  71                 struct bt_self_component_sink *self_component,
  72                 struct bt_self_component_port_input *self_port,
  73                 const struct bt_port_output *other_port);
  74
  75 typedef void
  76 (*bt_component_class_sink_input_port_disconnected_method)(
  77                 struct bt_self_component_sink *self_component,
  78                 struct bt_self_component_port_input *self_port);
  79
  80 typedef enum bt_self_component_status
  81 (*bt_component_class_sink_consume_method)(
  82         struct bt_self_component_sink *self_component);
  83
  84 static inline
  85 struct bt_component_class *bt_component_class_sink_as_component_class(
  86                 struct bt_component_class_sink *comp_cls_sink)
  87 {
  88         return (void *) comp_cls_sink;
  89 }
  90
  91 extern
  92 struct bt_component_class_sink *bt_component_class_sink_create(
  93                 const char *name,
  94                 bt_component_class_sink_consume_method method);
  95
  96 extern int bt_component_class_sink_set_init_method(
  97                 struct bt_component_class_sink *comp_class,
  98                 bt_component_class_sink_init_method method);
  99
 100 extern int bt_component_class_sink_set_finalize_method(
 101                 struct bt_component_class_sink *comp_class,
 102                 bt_component_class_sink_finalize_method method);
 103
 104 extern int bt_component_class_sink_set_accept_input_port_connection_method(
 105                 struct bt_component_class_sink *comp_class,
 106                 bt_component_class_sink_accept_input_port_connection_method method);
 107
 108 extern int bt_component_class_sink_set_input_port_connected_method(
 109                 struct bt_component_class_sink *comp_class,
 110                 bt_component_class_sink_input_port_connected_method method);
 111
 112 extern int bt_component_class_sink_set_input_port_disconnected_method(
 113                 struct bt_component_class_sink *comp_class,
 114                 bt_component_class_sink_input_port_disconnected_method method);
 115
 116 extern int bt_component_class_sink_set_query_method(
 117                 struct bt_component_class_sink *comp_class,
 118                 bt_component_class_sink_query_method method);
 119
 120 #ifdef __cplusplus
 121 }
 122 #endif
 123
 124 #endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_SINK_H */