include/babeltrace/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 <babeltrace/graph/self-component.h>
  31
  32 /* For bt_self_message_iterator_status */
  33 #include <babeltrace/graph/self-message-iterator.h>
  34
  35 /* For bt_query_status */
  36 #include <babeltrace/graph/component-class.h>
  37
  38 /* For bt_component_class_status */
  39 #include <babeltrace/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
  46  */
  47 #include <babeltrace/types.h>
  48
  49 #ifdef __cplusplus
  50 extern "C" {
  51 #endif
  52
  53 typedef bt_self_component_status
  54 (*bt_component_class_source_init_method)(
  55                 bt_self_component_source *self_component,
  56                 const bt_value *params, void *init_method_data);
  57
  58 typedef void (*bt_component_class_source_finalize_method)(
  59                 bt_self_component_source *self_component);
  60
  61 typedef bt_self_message_iterator_status
  62 (*bt_component_class_source_message_iterator_init_method)(
  63                 bt_self_message_iterator *message_iterator,
  64                 bt_self_component_source *self_component,
  65                 bt_self_component_port_output *port);
  66
  67 typedef void
  68 (*bt_component_class_source_message_iterator_finalize_method)(
  69                 bt_self_message_iterator *message_iterator);
  70
  71 typedef bt_self_message_iterator_status
  72 (*bt_component_class_source_message_iterator_next_method)(
  73                 bt_self_message_iterator *message_iterator,
  74                 bt_message_array_const msgs, uint64_t capacity,
  75                 uint64_t *count);
  76
  77 typedef bt_query_status (*bt_component_class_source_query_method)(
  78                 bt_self_component_class_source *comp_class,
  79                 const bt_query_executor *query_executor,
  80                 const char *object, const bt_value *params,
  81                 const bt_value **result);
  82
  83 typedef bt_self_component_status
  84 (*bt_component_class_source_accept_output_port_connection_method)(
  85                 bt_self_component_source *self_component,
  86                 bt_self_component_port_output *self_port,
  87                 const bt_port_input *other_port);
  88
  89 typedef bt_self_component_status
  90 (*bt_component_class_source_output_port_connected_method)(
  91                 bt_self_component_source *self_component,
  92                 bt_self_component_port_output *self_port,
  93                 const bt_port_input *other_port);
  94
  95 static inline
  96 bt_component_class *bt_component_class_source_as_component_class(
  97                 bt_component_class_source *comp_cls_source)
  98 {
  99         return (void *) comp_cls_source;
 100 }
 101
 102 extern
 103 bt_component_class_source *bt_component_class_source_create(
 104                 const char *name,
 105                 bt_component_class_source_message_iterator_next_method method);
 106
 107 extern bt_component_class_status
 108 bt_component_class_source_set_init_method(
 109                 bt_component_class_source *comp_class,
 110                 bt_component_class_source_init_method method);
 111
 112 extern bt_component_class_status
 113 bt_component_class_source_set_finalize_method(
 114                 bt_component_class_source *comp_class,
 115                 bt_component_class_source_finalize_method method);
 116
 117 extern bt_component_class_status
 118 bt_component_class_source_set_accept_output_port_connection_method(
 119                 bt_component_class_source *comp_class,
 120                 bt_component_class_source_accept_output_port_connection_method method);
 121
 122 extern bt_component_class_status
 123 bt_component_class_source_set_output_port_connected_method(
 124                 bt_component_class_source *comp_class,
 125                 bt_component_class_source_output_port_connected_method method);
 126
 127 extern bt_component_class_status
 128 bt_component_class_source_set_query_method(
 129                 bt_component_class_source *comp_class,
 130                 bt_component_class_source_query_method method);
 131
 132 extern bt_component_class_status
 133 bt_component_class_source_set_message_iterator_init_method(
 134                 bt_component_class_source *comp_class,
 135                 bt_component_class_source_message_iterator_init_method method);
 136
 137 extern bt_component_class_status
 138 bt_component_class_source_set_message_iterator_finalize_method(
 139                 bt_component_class_source *comp_class,
 140                 bt_component_class_source_message_iterator_finalize_method method);
 141
 142 #ifdef __cplusplus
 143 }
 144 #endif
 145
 146 #endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_SOURCE_H */