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