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