include/babeltrace/graph/component-class.h

   1 #ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_H
   2 #define BABELTRACE_GRAPH_COMPONENT_CLASS_H
   3
   4 /*
   5  * Babeltrace - Component Class Interface.
   6  *
   7  * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   8  *
   9  * Permission is hereby granted, free of charge, to any person obtaining a copy
  10  * of this software and associated documentation files (the "Software"), to deal
  11  * in the Software without restriction, including without limitation the rights
  12  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  13  * copies of the Software, and to permit persons to whom the Software is
  14  * furnished to do so, subject to the following conditions:
  15  *
  16  * The above copyright notice and this permission notice shall be included in
  17  * all copies or substantial portions of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  22  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  24  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  25  * SOFTWARE.
  26  */
  27
  28 #include <stdint.h>
  29 #include <babeltrace/graph/component-status.h>
  30 #include <babeltrace/graph/notification-iterator.h>
  31 #include <babeltrace/types.h>
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 struct bt_component_class;
  38 struct bt_component;
  39 struct bt_private_component;
  40 struct bt_private_port;
  41 struct bt_port;
  42 struct bt_value;
  43 struct bt_private_notification_iterator;
  44
  45 /**
  46  * Component class type.
  47  */
  48 enum bt_component_class_type {
  49         BT_COMPONENT_CLASS_TYPE_UNKNOWN =       -1,
  50
  51         /** A source component is a notification generator. */
  52         BT_COMPONENT_CLASS_TYPE_SOURCE =        0,
  53
  54         /** A sink component handles incoming notifications. */
  55         BT_COMPONENT_CLASS_TYPE_SINK =          1,
  56
  57         /** A filter component implements both Source and Sink interfaces. */
  58         BT_COMPONENT_CLASS_TYPE_FILTER =        2,
  59 };
  60
  61 struct bt_notification_iterator_next_return {
  62         struct bt_notification *notification;
  63         enum bt_notification_iterator_status status;
  64 };
  65
  66 typedef enum bt_component_status (*bt_component_class_init_method)(
  67                 struct bt_private_component *private_component,
  68                 struct bt_value *params, void *init_method_data);
  69
  70 typedef void (*bt_component_class_finalize_method)(
  71                 struct bt_private_component *private_component);
  72
  73 typedef enum bt_notification_iterator_status
  74                 (*bt_component_class_notification_iterator_init_method)(
  75                 struct bt_private_notification_iterator *private_notification_iterator,
  76                 struct bt_private_port *private_port);
  77
  78 typedef void (*bt_component_class_notification_iterator_finalize_method)(
  79                 struct bt_private_notification_iterator *private_notification_iterator);
  80
  81 typedef struct bt_notification_iterator_next_return (*bt_component_class_notification_iterator_next_method)(
  82                 struct bt_private_notification_iterator *private_notification_iterator);
  83
  84 typedef enum bt_notification_iterator_status
  85                 (*bt_component_class_notification_iterator_seek_time_method)(
  86                 struct bt_private_notification_iterator *private_notification_iterator,
  87                 int64_t time);
  88
  89 typedef struct bt_value *(*bt_component_class_query_method)(
  90                 struct bt_component_class *component_class,
  91                 const char *object, struct bt_value *params);
  92
  93 typedef enum bt_component_status (*bt_component_class_accept_port_connection_method)(
  94                 struct bt_private_component *private_component,
  95                 struct bt_private_port *self_private_port,
  96                 struct bt_port *other_port);
  97
  98 typedef void (*bt_component_class_port_connected_method)(
  99                 struct bt_private_component *private_component,
 100                 struct bt_private_port *self_private_port,
 101                 struct bt_port *other_port);
 102
 103 typedef void (*bt_component_class_port_disconnected_method)(
 104                 struct bt_private_component *private_component,
 105                 struct bt_private_port *private_port);
 106
 107 extern int bt_component_class_set_init_method(
 108                 struct bt_component_class *component_class,
 109                 bt_component_class_init_method init_method);
 110
 111 extern int bt_component_class_set_finalize_method(
 112                 struct bt_component_class *component_class,
 113                 bt_component_class_finalize_method finalize_method);
 114
 115 extern int bt_component_class_set_accept_port_connection_method(
 116                 struct bt_component_class *component_class,
 117                 bt_component_class_accept_port_connection_method accept_port_connection_method);
 118
 119 extern int bt_component_class_set_port_connected_method(
 120                 struct bt_component_class *component_class,
 121                 bt_component_class_port_connected_method port_connected_method);
 122
 123 extern int bt_component_class_set_port_disconnected_method(
 124                 struct bt_component_class *component_class,
 125                 bt_component_class_port_disconnected_method port_disconnected_method);
 126
 127 extern int bt_component_class_set_query_method(
 128                 struct bt_component_class *component_class,
 129                 bt_component_class_query_method query_method);
 130
 131 extern int bt_component_class_set_description(
 132                 struct bt_component_class *component_class,
 133                 const char *description);
 134
 135 extern int bt_component_class_set_help(
 136                 struct bt_component_class *component_class,
 137                 const char *help);
 138
 139 extern int bt_component_class_freeze(
 140                 struct bt_component_class *component_class);
 141
 142 /**
 143  * Get a component class' name.
 144  *
 145  * @param component_class       Component class of which to get the name
 146  * @returns                     Name of the component class
 147  */
 148 extern const char *bt_component_class_get_name(
 149                 struct bt_component_class *component_class);
 150
 151 /**
 152  * Get a component class' description.
 153  *
 154  * Component classes may provide an optional description. It may, however,
 155  * opt not to.
 156  *
 157  * @param component_class       Component class of which to get the description
 158  * @returns                     Description of the component class, or NULL.
 159  */
 160 extern const char *bt_component_class_get_description(
 161                 struct bt_component_class *component_class);
 162
 163 extern const char *bt_component_class_get_help(
 164                 struct bt_component_class *component_class);
 165
 166 extern struct bt_value *bt_component_class_query(
 167                 struct bt_component_class *component_class,
 168                 const char *object, struct bt_value *params);
 169
 170 /**
 171  * Get a component class' type.
 172  *
 173  * @param component_class       Component class of which to get the type
 174  * @returns                     One of #bt_component_type
 175  */
 176 extern enum bt_component_class_type bt_component_class_get_type(
 177                 struct bt_component_class *component_class);
 178
 179 static inline
 180 bt_bool bt_component_class_is_source(struct bt_component_class *component_class)
 181 {
 182         return bt_component_class_get_type(component_class) ==
 183                 BT_COMPONENT_CLASS_TYPE_SOURCE;
 184 }
 185
 186 static inline
 187 bt_bool bt_component_class_is_filter(struct bt_component_class *component_class)
 188 {
 189         return bt_component_class_get_type(component_class) ==
 190                 BT_COMPONENT_CLASS_TYPE_FILTER;
 191 }
 192
 193 static inline
 194 bt_bool bt_component_class_is_sink(struct bt_component_class *component_class)
 195 {
 196         return bt_component_class_get_type(component_class) ==
 197                 BT_COMPONENT_CLASS_TYPE_SINK;
 198 }
 199
 200 #ifdef __cplusplus
 201 }
 202 #endif
 203
 204 #endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_H */