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