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 typedef enum bt_component_status (*bt_component_class_init_method)(
  62                 struct bt_private_component *private_component,
  63                 struct bt_value *params, void *init_method_data);
  64
  65 typedef void (*bt_component_class_finalize_method)(
  66                 struct bt_private_component *private_component);
  67
  68 typedef enum bt_notification_iterator_status
  69                 (*bt_component_class_notification_iterator_init_method)(
  70                 struct bt_private_notification_iterator *private_notification_iterator,
  71                 struct bt_private_port *private_port);
  72
  73 typedef void (*bt_component_class_notification_iterator_finalize_method)(
  74                 struct bt_private_notification_iterator *private_notification_iterator);
  75
  76 typedef struct bt_notification_iterator_next_return (*bt_component_class_notification_iterator_next_method)(
  77                 struct bt_private_notification_iterator *private_notification_iterator);
  78
  79 typedef enum bt_notification_iterator_status
  80                 (*bt_component_class_notification_iterator_seek_time_method)(
  81                 struct bt_private_notification_iterator *private_notification_iterator,
  82                 int64_t time);
  83
  84 typedef struct bt_value *(*bt_component_class_query_method)(
  85                 struct bt_component_class *component_class,
  86                 const char *object, struct bt_value *params);
  87
  88 typedef enum bt_component_status (*bt_component_class_accept_port_connection_method)(
  89                 struct bt_private_component *private_component,
  90                 struct bt_private_port *self_private_port,
  91                 struct bt_port *other_port);
  92
  93 typedef void (*bt_component_class_port_connected_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_disconnected_method)(
  99                 struct bt_private_component *private_component,
 100                 struct bt_private_port *private_port);
 101
 102 extern int bt_component_class_set_init_method(
 103                 struct bt_component_class *component_class,
 104                 bt_component_class_init_method init_method);
 105
 106 extern int bt_component_class_set_finalize_method(
 107                 struct bt_component_class *component_class,
 108                 bt_component_class_finalize_method finalize_method);
 109
 110 extern int bt_component_class_set_accept_port_connection_method(
 111                 struct bt_component_class *component_class,
 112                 bt_component_class_accept_port_connection_method accept_port_connection_method);
 113
 114 extern int bt_component_class_set_port_connected_method(
 115                 struct bt_component_class *component_class,
 116                 bt_component_class_port_connected_method port_connected_method);
 117
 118 extern int bt_component_class_set_port_disconnected_method(
 119                 struct bt_component_class *component_class,
 120                 bt_component_class_port_disconnected_method port_disconnected_method);
 121
 122 extern int bt_component_class_set_query_method(
 123                 struct bt_component_class *component_class,
 124                 bt_component_class_query_method query_method);
 125
 126 extern int bt_component_class_set_description(
 127                 struct bt_component_class *component_class,
 128                 const char *description);
 129
 130 extern int bt_component_class_set_help(
 131                 struct bt_component_class *component_class,
 132                 const char *help);
 133
 134 extern int bt_component_class_freeze(
 135                 struct bt_component_class *component_class);
 136
 137 /**
 138  * Get a component class' name.
 139  *
 140  * @param component_class       Component class of which to get the name
 141  * @returns                     Name of the component class
 142  */
 143 extern const char *bt_component_class_get_name(
 144                 struct bt_component_class *component_class);
 145
 146 /**
 147  * Get a component class' description.
 148  *
 149  * Component classes may provide an optional description. It may, however,
 150  * opt not to.
 151  *
 152  * @param component_class       Component class of which to get the description
 153  * @returns                     Description of the component class, or NULL.
 154  */
 155 extern const char *bt_component_class_get_description(
 156                 struct bt_component_class *component_class);
 157
 158 extern const char *bt_component_class_get_help(
 159                 struct bt_component_class *component_class);
 160
 161 extern struct bt_value *bt_component_class_query(
 162                 struct bt_component_class *component_class,
 163                 const char *object, struct bt_value *params);
 164
 165 /**
 166  * Get a component class' type.
 167  *
 168  * @param component_class       Component class of which to get the type
 169  * @returns                     One of #bt_component_type
 170  */
 171 extern enum bt_component_class_type bt_component_class_get_type(
 172                 struct bt_component_class *component_class);
 173
 174 static inline
 175 bt_bool bt_component_class_is_source(struct bt_component_class *component_class)
 176 {
 177         return bt_component_class_get_type(component_class) ==
 178                 BT_COMPONENT_CLASS_TYPE_SOURCE;
 179 }
 180
 181 static inline
 182 bt_bool bt_component_class_is_filter(struct bt_component_class *component_class)
 183 {
 184         return bt_component_class_get_type(component_class) ==
 185                 BT_COMPONENT_CLASS_TYPE_FILTER;
 186 }
 187
 188 static inline
 189 bt_bool bt_component_class_is_sink(struct bt_component_class *component_class)
 190 {
 191         return bt_component_class_get_type(component_class) ==
 192                 BT_COMPONENT_CLASS_TYPE_SINK;
 193 }
 194
 195 #ifdef __cplusplus
 196 }
 197 #endif
 198
 199 #endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_H */