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

   1 #ifndef BABELTRACE2_GRAPH_COMPONENT_CLASS_SINK_H
   2 #define BABELTRACE2_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 #ifndef __BT_IN_BABELTRACE_H
  28 # error "Please include <babeltrace2/babeltrace.h> instead."
  29 #endif
  30
  31 #include <stdint.h>
  32
  33 #include <babeltrace2/graph/component-class.h>
  34 #include <babeltrace2/types.h>
  35 #include <babeltrace2/logging.h>
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 typedef bt_component_class_init_method_status
  42 (*bt_component_class_sink_init_method)(
  43                 bt_self_component_sink *self_component,
  44                 const bt_value *params, void *init_method_data);
  45
  46 typedef void (*bt_component_class_sink_finalize_method)(
  47                 bt_self_component_sink *self_component);
  48
  49 typedef bt_component_class_query_method_status
  50 (*bt_component_class_sink_query_method)(
  51                 bt_self_component_class_sink *comp_class,
  52                 const bt_query_executor *query_executor,
  53                 const char *object, const bt_value *params,
  54                 bt_logging_level logging_level,
  55                 const bt_value **result);
  56
  57 typedef bt_component_class_port_connected_method_status
  58 (*bt_component_class_sink_input_port_connected_method)(
  59                 bt_self_component_sink *self_component,
  60                 bt_self_component_port_input *self_port,
  61                 const bt_port_output *other_port);
  62
  63 typedef enum bt_component_class_sink_graph_is_configured_method_status {
  64         BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_OK            = __BT_FUNC_STATUS_OK,
  65         BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_ERROR         = __BT_FUNC_STATUS_ERROR,
  66         BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_MEMORY_ERROR  = __BT_FUNC_STATUS_MEMORY_ERROR,
  67 } bt_component_class_sink_graph_is_configured_method_status;
  68
  69 typedef bt_component_class_sink_graph_is_configured_method_status
  70 (*bt_component_class_sink_graph_is_configured_method)(
  71                 bt_self_component_sink *self_component);
  72
  73 typedef enum bt_component_class_sink_consume_method_status {
  74         BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_OK                = __BT_FUNC_STATUS_OK,
  75         BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_ERROR             = __BT_FUNC_STATUS_ERROR,
  76         BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_MEMORY_ERROR      = __BT_FUNC_STATUS_MEMORY_ERROR,
  77         BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_AGAIN             = __BT_FUNC_STATUS_AGAIN,
  78         BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_END               = __BT_FUNC_STATUS_END,
  79 } bt_component_class_sink_consume_method_status;
  80
  81 typedef bt_component_class_sink_consume_method_status
  82 (*bt_component_class_sink_consume_method)(
  83                 bt_self_component_sink *self_component);
  84
  85 static inline
  86 bt_component_class *bt_component_class_sink_as_component_class(
  87                 bt_component_class_sink *comp_cls_sink)
  88 {
  89         return __BT_UPCAST(bt_component_class, comp_cls_sink);
  90 }
  91
  92 extern
  93 bt_component_class_sink *bt_component_class_sink_create(
  94                 const char *name,
  95                 bt_component_class_sink_consume_method method);
  96
  97 extern
  98 bt_component_class_set_method_status
  99 bt_component_class_sink_set_init_method(
 100                 bt_component_class_sink *comp_class,
 101                 bt_component_class_sink_init_method method);
 102
 103 extern
 104 bt_component_class_set_method_status
 105 bt_component_class_sink_set_finalize_method(
 106                 bt_component_class_sink *comp_class,
 107                 bt_component_class_sink_finalize_method method);
 108
 109 extern
 110 bt_component_class_set_method_status
 111 bt_component_class_sink_set_input_port_connected_method(
 112                 bt_component_class_sink *comp_class,
 113                 bt_component_class_sink_input_port_connected_method method);
 114
 115 extern
 116 bt_component_class_set_method_status
 117 bt_component_class_sink_set_graph_is_configured_method(
 118                 bt_component_class_sink *comp_class,
 119                 bt_component_class_sink_graph_is_configured_method method);
 120
 121 extern
 122 bt_component_class_set_method_status
 123 bt_component_class_sink_set_query_method(
 124                 bt_component_class_sink *comp_class,
 125                 bt_component_class_sink_query_method method);
 126
 127 #ifdef __cplusplus
 128 }
 129 #endif
 130
 131 #endif /* BABELTRACE2_GRAPH_COMPONENT_CLASS_SINK_H */