include/babeltrace/graph/component-class.h

   1 #ifndef BABELTRACE_COMPONENT_COMPONENT_CLASS_H
   2 #define BABELTRACE_COMPONENT_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
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 struct bt_component_class;
  37 struct bt_component;
  38 struct bt_private_component;
  39 struct bt_private_port;
  40 struct bt_port;
  41 struct bt_value;
  42 struct bt_private_notification_iterator;
  43
  44 /**
  45  * Component class type.
  46  */
  47 enum bt_component_class_type {
  48         BT_COMPONENT_CLASS_TYPE_UNKNOWN =       -1,
  49
  50         /** A source component is a notification generator. */
  51         BT_COMPONENT_CLASS_TYPE_SOURCE =        0,
  52
  53         /** A sink component handles incoming notifications. */
  54         BT_COMPONENT_CLASS_TYPE_SINK =          1,
  55
  56         /** A filter component implements both Source and Sink interfaces. */
  57         BT_COMPONENT_CLASS_TYPE_FILTER =        2,
  58 };
  59
  60 typedef enum bt_component_status (*bt_component_class_init_method)(
  61                 struct bt_private_component *private_component,
  62                 struct bt_value *params, void *init_method_data);
  63
  64 typedef void (*bt_component_class_finalize_method)(
  65                 struct bt_private_component *private_component);
  66
  67 typedef enum bt_notification_iterator_status
  68                 (*bt_component_class_notification_iterator_init_method)(
  69                 struct bt_private_notification_iterator *private_notification_iterator,
  70                 struct bt_private_port *private_port);
  71
  72 typedef void (*bt_component_class_notification_iterator_finalize_method)(
  73                 struct bt_private_notification_iterator *private_notification_iterator);
  74
  75 typedef struct bt_notification_iterator_next_return (*bt_component_class_notification_iterator_next_method)(
  76                 struct bt_private_notification_iterator *private_notification_iterator);
  77
  78 typedef enum bt_notification_iterator_status
  79                 (*bt_component_class_notification_iterator_seek_time_method)(
  80                 struct bt_private_notification_iterator *private_notification_iterator,
  81                 int64_t time);
  82
  83 typedef struct bt_value *(*bt_component_class_query_method)(
  84                 struct bt_component_class *component_class,
  85                 const char *object, struct bt_value *params);
  86
  87 typedef enum bt_component_status (*bt_component_class_accept_port_connection_method)(
  88                 struct bt_private_component *private_component,
  89                 struct bt_private_port *self_private_port,
  90                 struct bt_port *other_port);
  91
  92 typedef void (*bt_component_class_port_connected_method)(
  93                 struct bt_private_component *private_component,
  94                 struct bt_private_port *self_private_port,
  95                 struct bt_port *other_port);
  96
  97 typedef void (*bt_component_class_port_disconnected_method)(
  98                 struct bt_private_component *private_component,
  99                 struct bt_private_port *private_port);
 100
 101 extern int bt_component_class_set_init_method(
 102                 struct bt_component_class *component_class,
 103                 bt_component_class_init_method init_method);
 104
 105 extern int bt_component_class_set_finalize_method(
 106                 struct bt_component_class *component_class,
 107                 bt_component_class_finalize_method finalize_method);
 108
 109 extern int bt_component_class_set_accept_port_connection_method(
 110                 struct bt_component_class *component_class,
 111                 bt_component_class_accept_port_connection_method accept_port_connection_method);
 112
 113 extern int bt_component_class_set_port_connected_method(
 114                 struct bt_component_class *component_class,
 115                 bt_component_class_port_connected_method port_connected_method);
 116
 117 extern int bt_component_class_set_port_disconnected_method(
 118                 struct bt_component_class *component_class,
 119                 bt_component_class_port_disconnected_method port_disconnected_method);
 120
 121 extern int bt_component_class_set_query_method(
 122                 struct bt_component_class *component_class,
 123                 bt_component_class_query_method query_method);
 124
 125 extern int bt_component_class_set_description(
 126                 struct bt_component_class *component_class,
 127                 const char *description);
 128
 129 extern int bt_component_class_set_help(
 130                 struct bt_component_class *component_class,
 131                 const char *help);
 132
 133 extern int bt_component_class_freeze(
 134                 struct bt_component_class *component_class);
 135
 136 /**
 137  * Get a component class' name.
 138  *
 139  * @param component_class       Component class of which to get the name
 140  * @returns                     Name of the component class
 141  */
 142 extern const char *bt_component_class_get_name(
 143                 struct bt_component_class *component_class);
 144
 145 /**
 146  * Get a component class' description.
 147  *
 148  * Component classes may provide an optional description. It may, however,
 149  * opt not to.
 150  *
 151  * @param component_class       Component class of which to get the description
 152  * @returns                     Description of the component class, or NULL.
 153  */
 154 extern const char *bt_component_class_get_description(
 155                 struct bt_component_class *component_class);
 156
 157 extern const char *bt_component_class_get_help(
 158                 struct bt_component_class *component_class);
 159
 160 extern struct bt_value *bt_component_class_query(
 161                 struct bt_component_class *component_class,
 162                 const char *object, struct bt_value *params);
 163
 164 /**
 165  * Get a component class' type.
 166  *
 167  * @param component_class       Component class of which to get the type
 168  * @returns                     One of #bt_component_type
 169  */
 170 extern enum bt_component_class_type bt_component_class_get_type(
 171                 struct bt_component_class *component_class);
 172
 173 #ifdef __cplusplus
 174 }
 175 #endif
 176
 177 #endif /* BABELTRACE_COMPONENT_COMPONENT_CLASS_H */