include/babeltrace/graph/private-component-class-source.h

   1 #ifndef BABELTRACE_GRAPH_PRIVATE_COMPONENT_CLASS_SOURCE_H
   2 #define BABELTRACE_GRAPH_PRIVATE_COMPONENT_CLASS_SOURCE_H
   3
   4 /*
   5  * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   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 #include <stdint.h>
  27
  28 /* For enum bt_notification_array */
  29 #include <babeltrace/graph/notification.h>
  30
  31 /* For enum bt_self_component_status */
  32 #include <babeltrace/graph/self-component.h>
  33
  34 /* For enum bt_self_notification_iterator_status */
  35 #include <babeltrace/graph/self-notification-iterator.h>
  36
  37 /* For enum bt_query_status */
  38 #include <babeltrace/graph/private-component-class.h>
  39
  40 #ifdef __cplusplus
  41 extern "C" {
  42 #endif
  43
  44 struct bt_self_component_class_source;
  45 struct bt_component_class_source;
  46 struct bt_self_component_source;
  47 struct bt_private_component_class;
  48 struct bt_private_component_class_source;
  49 struct bt_self_component_port_output;
  50 struct bt_port_input;
  51 struct bt_query_executor;
  52 struct bt_value;
  53
  54 typedef enum bt_self_component_status
  55 (*bt_private_component_class_source_init_method)(
  56                 struct bt_self_component_source *self_component,
  57                 const struct bt_value *params, void *init_method_data);
  58
  59 typedef void (*bt_private_component_class_source_finalize_method)(
  60                 struct bt_self_component_source *self_component);
  61
  62 typedef enum bt_self_notification_iterator_status
  63 (*bt_private_component_class_source_notification_iterator_init_method)(
  64                 struct bt_self_notification_iterator *notification_iterator,
  65                 struct bt_self_component_source *self_component,
  66                 struct bt_self_component_port_output *port);
  67
  68 typedef void
  69 (*bt_private_component_class_source_notification_iterator_finalize_method)(
  70                 struct bt_self_notification_iterator *notification_iterator);
  71
  72 typedef enum bt_self_notification_iterator_status
  73 (*bt_private_component_class_source_notification_iterator_next_method)(
  74                 struct bt_self_notification_iterator *notification_iterator,
  75                 bt_notification_array notifs, uint64_t capacity,
  76                 uint64_t *count);
  77
  78 typedef enum bt_query_status
  79 (*bt_private_component_class_source_query_method)(
  80                 struct bt_self_component_class_source *comp_class,
  81                 struct bt_query_executor *query_executor,
  82                 const char *object, const struct bt_value *params,
  83                 const struct bt_value **result);
  84
  85 typedef enum bt_self_component_status
  86 (*bt_private_component_class_source_accept_output_port_connection_method)(
  87                 struct bt_self_component_source *self_component,
  88                 struct bt_self_component_port_output *self_port,
  89                 struct bt_port_input *other_port);
  90
  91 typedef enum bt_self_component_status
  92 (*bt_private_component_class_source_output_port_connected_method)(
  93                 struct bt_self_component_source *self_component,
  94                 struct bt_self_component_port_output *self_port,
  95                 struct bt_port_input *other_port);
  96
  97 typedef void
  98 (*bt_private_component_class_source_output_port_disconnected_method)(
  99                 struct bt_self_component_source *self_component,
 100                 struct bt_self_component_port_output *self_port);
 101
 102 static inline
 103 struct bt_private_component_class *
 104 bt_private_component_class_source_as_private_component_class(
 105                 struct bt_private_component_class_source *priv_comp_cls_source)
 106 {
 107         return (void *) priv_comp_cls_source;
 108 }
 109
 110 static inline
 111 struct bt_component_class_source *
 112 bt_private_component_class_source_as_component_class_source(
 113                 struct bt_private_component_class_source *priv_comp_cls_source)
 114 {
 115         return (void *) priv_comp_cls_source;
 116 }
 117
 118 extern
 119 struct bt_private_component_class_source *
 120 bt_private_component_class_source_create(
 121                 const char *name,
 122                 bt_private_component_class_source_notification_iterator_next_method method);
 123
 124 extern int bt_private_component_class_source_set_init_method(
 125                 struct bt_private_component_class_source *comp_class,
 126                 bt_private_component_class_source_init_method method);
 127
 128 extern int bt_private_component_class_source_set_finalize_method(
 129                 struct bt_private_component_class_source *comp_class,
 130                 bt_private_component_class_source_finalize_method method);
 131
 132 extern int bt_private_component_class_source_set_accept_output_port_connection_method(
 133                 struct bt_private_component_class_source *comp_class,
 134                 bt_private_component_class_source_accept_output_port_connection_method method);
 135
 136 extern int bt_private_component_class_source_set_output_port_connected_method(
 137                 struct bt_private_component_class_source *comp_class,
 138                 bt_private_component_class_source_output_port_connected_method method);
 139
 140 extern int bt_private_component_class_source_set_output_port_disconnected_method(
 141                 struct bt_private_component_class_source *comp_class,
 142                 bt_private_component_class_source_output_port_disconnected_method method);
 143
 144 extern int bt_private_component_class_source_set_query_method(
 145                 struct bt_private_component_class_source *comp_class,
 146                 bt_private_component_class_source_query_method method);
 147
 148 extern int bt_private_component_class_source_set_notification_iterator_init_method(
 149                 struct bt_private_component_class_source *comp_class,
 150                 bt_private_component_class_source_notification_iterator_init_method method);
 151
 152 extern int bt_private_component_class_source_set_notification_iterator_finalize_method(
 153                 struct bt_private_component_class_source *comp_class,
 154                 bt_private_component_class_source_notification_iterator_finalize_method method);
 155
 156 #ifdef __cplusplus
 157 }
 158 #endif
 159
 160 #endif /* BABELTRACE_GRAPH_PRIVATE_COMPONENT_CLASS_SOURCE_H */