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

   1 #ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_SOURCE_H
   2 #define BABELTRACE_GRAPH_COMPONENT_CLASS_SOURCE_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_self_message_iterator_status */
  33 #include <babeltrace2/graph/self-message-iterator.h>
  34
  35 /* For bt_query_status */
  36 #include <babeltrace2/graph/component-class.h>
  37
  38 /* For bt_component_class_status */
  39 #include <babeltrace2/graph/component-class-const.h>
  40
  41 /*
  42  * For bt_component_class, bt_component_class_source, bt_port_input,
  43  * bt_query_executor, bt_self_component_class_source,
  44  * bt_self_component_source, bt_self_component_port_output, bt_value,
  45  * bt_message_array_const, bt_bool, bt_self_message_iterator,
  46  * __BT_UPCAST
  47  */
  48 #include <babeltrace2/types.h>
  49
  50 /* For bt_logging_level */
  51 #include <babeltrace2/logging.h>
  52
  53 #ifdef __cplusplus
  54 extern "C" {
  55 #endif
  56
  57 typedef bt_self_component_status
  58 (*bt_component_class_source_init_method)(
  59                 bt_self_component_source *self_component,
  60                 const bt_value *params, void *init_method_data);
  61
  62 typedef void (*bt_component_class_source_finalize_method)(
  63                 bt_self_component_source *self_component);
  64
  65 typedef bt_self_message_iterator_status
  66 (*bt_component_class_source_message_iterator_init_method)(
  67                 bt_self_message_iterator *message_iterator,
  68                 bt_self_component_source *self_component,
  69                 bt_self_component_port_output *port);
  70
  71 typedef void
  72 (*bt_component_class_source_message_iterator_finalize_method)(
  73                 bt_self_message_iterator *message_iterator);
  74
  75 typedef bt_self_message_iterator_status
  76 (*bt_component_class_source_message_iterator_next_method)(
  77                 bt_self_message_iterator *message_iterator,
  78                 bt_message_array_const msgs, uint64_t capacity,
  79                 uint64_t *count);
  80
  81 typedef bt_self_message_iterator_status
  82 (*bt_component_class_source_message_iterator_seek_ns_from_origin_method)(
  83                 bt_self_message_iterator *message_iterator,
  84                 int64_t ns_from_origin);
  85
  86 typedef bt_self_message_iterator_status
  87 (*bt_component_class_source_message_iterator_seek_beginning_method)(
  88                 bt_self_message_iterator *message_iterator);
  89
  90 typedef bt_bool
  91 (*bt_component_class_source_message_iterator_can_seek_ns_from_origin_method)(
  92                 bt_self_message_iterator *message_iterator,
  93                 int64_t ns_from_origin);
  94
  95 typedef bt_bool
  96 (*bt_component_class_source_message_iterator_can_seek_beginning_method)(
  97                 bt_self_message_iterator *message_iterator);
  98
  99 typedef bt_query_status (*bt_component_class_source_query_method)(
 100                 bt_self_component_class_source *comp_class,
 101                 const bt_query_executor *query_executor,
 102                 const char *object, const bt_value *params,
 103                 bt_logging_level logging_level,
 104                 const bt_value **result);
 105
 106 typedef bt_self_component_status
 107 (*bt_component_class_source_output_port_connected_method)(
 108                 bt_self_component_source *self_component,
 109                 bt_self_component_port_output *self_port,
 110                 const bt_port_input *other_port);
 111
 112 static inline
 113 bt_component_class *bt_component_class_source_as_component_class(
 114                 bt_component_class_source *comp_cls_source)
 115 {
 116         return __BT_UPCAST(bt_component_class, comp_cls_source);
 117 }
 118
 119 extern
 120 bt_component_class_source *bt_component_class_source_create(
 121                 const char *name,
 122                 bt_component_class_source_message_iterator_next_method method);
 123
 124 extern bt_component_class_status
 125 bt_component_class_source_set_init_method(
 126                 bt_component_class_source *comp_class,
 127                 bt_component_class_source_init_method method);
 128
 129 extern bt_component_class_status
 130 bt_component_class_source_set_finalize_method(
 131                 bt_component_class_source *comp_class,
 132                 bt_component_class_source_finalize_method method);
 133
 134 extern bt_component_class_status
 135 bt_component_class_source_set_output_port_connected_method(
 136                 bt_component_class_source *comp_class,
 137                 bt_component_class_source_output_port_connected_method method);
 138
 139 extern bt_component_class_status
 140 bt_component_class_source_set_query_method(
 141                 bt_component_class_source *comp_class,
 142                 bt_component_class_source_query_method method);
 143
 144 extern bt_component_class_status
 145 bt_component_class_source_set_message_iterator_init_method(
 146                 bt_component_class_source *comp_class,
 147                 bt_component_class_source_message_iterator_init_method method);
 148
 149 extern bt_component_class_status
 150 bt_component_class_source_set_message_iterator_finalize_method(
 151                 bt_component_class_source *comp_class,
 152                 bt_component_class_source_message_iterator_finalize_method method);
 153
 154 extern bt_component_class_status
 155 bt_component_class_source_set_message_iterator_seek_ns_from_origin_method(
 156                 bt_component_class_source *comp_class,
 157                 bt_component_class_source_message_iterator_seek_ns_from_origin_method method);
 158
 159 extern bt_component_class_status
 160 bt_component_class_source_set_message_iterator_seek_beginning_method(
 161                 bt_component_class_source *comp_class,
 162                 bt_component_class_source_message_iterator_seek_beginning_method method);
 163
 164 extern bt_bool
 165 bt_component_class_source_set_message_iterator_can_seek_ns_from_origin_method(
 166                 bt_component_class_source *comp_class,
 167                 bt_component_class_source_message_iterator_can_seek_ns_from_origin_method method);
 168
 169 extern bt_bool
 170 bt_component_class_source_set_message_iterator_can_seek_beginning_method(
 171                 bt_component_class_source *comp_class,
 172                 bt_component_class_source_message_iterator_can_seek_beginning_method method);
 173
 174 #ifdef __cplusplus
 175 }
 176 #endif
 177
 178 #endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_SOURCE_H */