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