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

   1 #ifndef BABELTRACE2_GRAPH_COMPONENT_CLASS_SOURCE_H
   2 #define BABELTRACE2_GRAPH_COMPONENT_CLASS_SOURCE_H
   3
   4 /*
   5  * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  */
  25
  26 #ifndef __BT_IN_BABELTRACE_H
  27 # error "Please include <babeltrace2/babeltrace.h> instead."
  28 #endif
  29
  30 #include <stdint.h>
  31
  32 #include <babeltrace2/graph/component-class.h>
  33 #include <babeltrace2/types.h>
  34 #include <babeltrace2/logging.h>
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 typedef bt_component_class_get_supported_mip_versions_method_status
  41 (*bt_component_class_source_get_supported_mip_versions_method)(
  42                 bt_self_component_class_source *comp_class,
  43                 const bt_value *params, void *init_method_data,
  44                 bt_logging_level log_level,
  45                 bt_integer_range_set_unsigned *supported_versions);
  46
  47 typedef bt_component_class_init_method_status
  48 (*bt_component_class_source_init_method)(
  49                 bt_self_component_source *self_component,
  50                 const bt_value *params, void *init_method_data);
  51
  52 typedef void (*bt_component_class_source_finalize_method)(
  53                 bt_self_component_source *self_component);
  54
  55 typedef bt_component_class_message_iterator_init_method_status
  56 (*bt_component_class_source_message_iterator_init_method)(
  57                 bt_self_message_iterator *message_iterator,
  58                 bt_self_component_source *self_component,
  59                 bt_self_component_port_output *port);
  60
  61 typedef void
  62 (*bt_component_class_source_message_iterator_finalize_method)(
  63                 bt_self_message_iterator *message_iterator);
  64
  65 typedef bt_component_class_message_iterator_next_method_status
  66 (*bt_component_class_source_message_iterator_next_method)(
  67                 bt_self_message_iterator *message_iterator,
  68                 bt_message_array_const msgs, uint64_t capacity,
  69                 uint64_t *count);
  70
  71 typedef bt_component_class_message_iterator_seek_ns_from_origin_method_status
  72 (*bt_component_class_source_message_iterator_seek_ns_from_origin_method)(
  73                 bt_self_message_iterator *message_iterator,
  74                 int64_t ns_from_origin);
  75
  76 typedef bt_component_class_message_iterator_seek_beginning_method_status
  77 (*bt_component_class_source_message_iterator_seek_beginning_method)(
  78                 bt_self_message_iterator *message_iterator);
  79
  80 typedef bt_component_class_message_iterator_can_seek_ns_from_origin_method_status
  81 (*bt_component_class_source_message_iterator_can_seek_ns_from_origin_method)(
  82                 bt_self_message_iterator *message_iterator,
  83                 int64_t ns_from_origin, bt_bool *can_seek);
  84
  85 typedef bt_component_class_message_iterator_can_seek_beginning_method_status
  86 (*bt_component_class_source_message_iterator_can_seek_beginning_method)(
  87                 bt_self_message_iterator *message_iterator, bt_bool *can_seek);
  88
  89 typedef bt_component_class_query_method_status
  90 (*bt_component_class_source_query_method)(
  91                 bt_self_component_class_source *comp_class,
  92                 bt_private_query_executor *query_executor,
  93                 const char *object, const bt_value *params,
  94                 void *method_data, const bt_value **result);
  95
  96 typedef bt_component_class_port_connected_method_status
  97 (*bt_component_class_source_output_port_connected_method)(
  98                 bt_self_component_source *self_component,
  99                 bt_self_component_port_output *self_port,
 100                 const bt_port_input *other_port);
 101
 102 static inline
 103 bt_component_class *bt_component_class_source_as_component_class(
 104                 bt_component_class_source *comp_cls_source)
 105 {
 106         return __BT_UPCAST(bt_component_class, comp_cls_source);
 107 }
 108
 109 extern
 110 bt_component_class_source *bt_component_class_source_create(
 111                 const char *name,
 112                 bt_component_class_source_message_iterator_next_method method);
 113
 114 extern bt_component_class_set_method_status
 115 bt_component_class_source_set_get_supported_mip_versions_method(
 116                 bt_component_class_source *comp_class,
 117                 bt_component_class_source_get_supported_mip_versions_method method);
 118
 119 extern bt_component_class_set_method_status
 120 bt_component_class_source_set_init_method(
 121                 bt_component_class_source *comp_class,
 122                 bt_component_class_source_init_method method);
 123
 124 extern bt_component_class_set_method_status
 125 bt_component_class_source_set_finalize_method(
 126                 bt_component_class_source *comp_class,
 127                 bt_component_class_source_finalize_method method);
 128
 129 extern bt_component_class_set_method_status
 130 bt_component_class_source_set_output_port_connected_method(
 131                 bt_component_class_source *comp_class,
 132                 bt_component_class_source_output_port_connected_method method);
 133
 134 extern bt_component_class_set_method_status
 135 bt_component_class_source_set_query_method(
 136                 bt_component_class_source *comp_class,
 137                 bt_component_class_source_query_method method);
 138
 139 extern bt_component_class_set_method_status
 140 bt_component_class_source_set_message_iterator_init_method(
 141                 bt_component_class_source *comp_class,
 142                 bt_component_class_source_message_iterator_init_method method);
 143
 144 extern bt_component_class_set_method_status
 145 bt_component_class_source_set_message_iterator_finalize_method(
 146                 bt_component_class_source *comp_class,
 147                 bt_component_class_source_message_iterator_finalize_method method);
 148
 149 extern bt_component_class_set_method_status
 150 bt_component_class_source_set_message_iterator_seek_ns_from_origin_method(
 151                 bt_component_class_source *comp_class,
 152                 bt_component_class_source_message_iterator_seek_ns_from_origin_method method);
 153
 154 extern bt_component_class_set_method_status
 155 bt_component_class_source_set_message_iterator_seek_beginning_method(
 156                 bt_component_class_source *comp_class,
 157                 bt_component_class_source_message_iterator_seek_beginning_method method);
 158
 159 extern bt_component_class_set_method_status
 160 bt_component_class_source_set_message_iterator_can_seek_ns_from_origin_method(
 161                 bt_component_class_source *comp_class,
 162                 bt_component_class_source_message_iterator_can_seek_ns_from_origin_method method);
 163
 164 extern bt_component_class_set_method_status
 165 bt_component_class_source_set_message_iterator_can_seek_beginning_method(
 166                 bt_component_class_source *comp_class,
 167                 bt_component_class_source_message_iterator_can_seek_beginning_method method);
 168
 169 #ifdef __cplusplus
 170 }
 171 #endif
 172
 173 #endif /* BABELTRACE2_GRAPH_COMPONENT_CLASS_SOURCE_H */