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_component_class_*_status */
  30 #include <babeltrace2/graph/component-class.h>
  31
  32 /*
  33  * For bt_component_class, bt_component_class_sink, bt_port_output,
  34  * bt_query_executor, bt_self_component_class_sink,
  35  * bt_self_component_sink, bt_self_component_port_input, bt_value,
  36  * __BT_UPCAST
  37  */
  38 #include <babeltrace2/types.h>
  39
  40 /* For bt_logging_level */
  41 #include <babeltrace2/logging.h>
  42
  43 /* For __BT_FUNC_STATUS_* */
  44 #define __BT_FUNC_STATUS_ENABLE
  45 #include <babeltrace2/func-status.h>
  46 #undef __BT_FUNC_STATUS_ENABLE
  47
  48 #ifdef __cplusplus
  49 extern "C" {
  50 #endif
  51
  52 typedef bt_component_class_init_method_status
  53 (*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_component_class_query_method_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_component_class_port_connected_method_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 enum bt_component_class_sink_graph_is_configured_method_status {
  75         BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_OK            = __BT_FUNC_STATUS_OK,
  76         BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_ERROR         = __BT_FUNC_STATUS_ERROR,
  77         BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_MEMORY_ERROR  = __BT_FUNC_STATUS_MEMORY_ERROR,
  78 } bt_component_class_sink_graph_is_configured_method_status;
  79
  80 typedef bt_component_class_sink_graph_is_configured_method_status
  81 (*bt_component_class_sink_graph_is_configured_method)(
  82                 bt_self_component_sink *self_component);
  83
  84 typedef enum bt_component_class_sink_consume_method_status {
  85         BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_OK                = __BT_FUNC_STATUS_OK,
  86         BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_ERROR             = __BT_FUNC_STATUS_ERROR,
  87         BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_MEMORY_ERROR      = __BT_FUNC_STATUS_MEMORY_ERROR,
  88         BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_AGAIN             = __BT_FUNC_STATUS_AGAIN,
  89         BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_END               = __BT_FUNC_STATUS_END,
  90 } bt_component_class_sink_consume_method_status;
  91
  92 typedef bt_component_class_sink_consume_method_status
  93 (*bt_component_class_sink_consume_method)(
  94                 bt_self_component_sink *self_component);
  95
  96 static inline
  97 bt_component_class *bt_component_class_sink_as_component_class(
  98                 bt_component_class_sink *comp_cls_sink)
  99 {
 100         return __BT_UPCAST(bt_component_class, comp_cls_sink);
 101 }
 102
 103 extern
 104 bt_component_class_sink *bt_component_class_sink_create(
 105                 const char *name,
 106                 bt_component_class_sink_consume_method method);
 107
 108 extern
 109 bt_component_class_set_method_status
 110 bt_component_class_sink_set_init_method(
 111                 bt_component_class_sink *comp_class,
 112                 bt_component_class_sink_init_method method);
 113
 114 extern
 115 bt_component_class_set_method_status
 116 bt_component_class_sink_set_finalize_method(
 117                 bt_component_class_sink *comp_class,
 118                 bt_component_class_sink_finalize_method method);
 119
 120 extern
 121 bt_component_class_set_method_status
 122 bt_component_class_sink_set_input_port_connected_method(
 123                 bt_component_class_sink *comp_class,
 124                 bt_component_class_sink_input_port_connected_method method);
 125
 126 extern
 127 bt_component_class_set_method_status
 128 bt_component_class_sink_set_graph_is_configured_method(
 129                 bt_component_class_sink *comp_class,
 130                 bt_component_class_sink_graph_is_configured_method method);
 131
 132 extern
 133 bt_component_class_set_method_status
 134 bt_component_class_sink_set_query_method(
 135                 bt_component_class_sink *comp_class,
 136                 bt_component_class_sink_query_method method);
 137
 138 #ifdef __cplusplus
 139 }
 140 #endif
 141
 142 #include <babeltrace2/undef-func-status.h>
 143
 144 #endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_SINK_H */