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_port;
  38 struct bt_connection;
  39 struct bt_value;
  40 struct bt_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_component *component, struct bt_value *params,
  60                 void *init_method_data);
  61
  62 typedef void (*bt_component_class_destroy_method)(struct bt_component *component);
  63
  64 typedef enum bt_notification_iterator_status
  65                 (*bt_component_class_notification_iterator_init_method)(
  66                 struct bt_component *component,
  67                 struct bt_notification_iterator *iterator, void *init_method_data);
  68
  69 typedef void (*bt_component_class_notification_iterator_destroy_method)(
  70                 struct bt_notification_iterator *iterator);
  71
  72 typedef struct bt_notification *(*bt_component_class_notification_iterator_get_method)(
  73                 struct bt_notification_iterator *iterator);
  74
  75 typedef enum bt_notification_iterator_status (*bt_component_class_notification_iterator_next_method)(
  76                 struct bt_notification_iterator *iterator);
  77
  78 typedef enum bt_notification_iterator_status
  79                 (*bt_component_class_notification_iterator_seek_time_method)(
  80                 struct bt_notification_iterator *iterator, int64_t time);
  81
  82 typedef struct bt_value *(*bt_component_class_query_method)(
  83                 struct bt_component_class *component_class,
  84                 const char *object, struct bt_value *params);
  85
  86 typedef enum bt_component_status (*bt_component_class_new_connection_method)(
  87                 struct bt_port *own_port, struct bt_connection *connection);
  88
  89 extern int bt_component_class_set_init_method(
  90                 struct bt_component_class *component_class,
  91                 bt_component_class_init_method init_method);
  92
  93 extern int bt_component_class_set_destroy_method(
  94                 struct bt_component_class *component_class,
  95                 bt_component_class_destroy_method destroy_method);
  96
  97 extern int bt_component_class_set_new_connection_method(
  98                 struct bt_component_class *component_class,
  99                 bt_component_class_new_connection_method new_connection_method);
 100
 101 extern int bt_component_class_set_description(
 102                 struct bt_component_class *component_class,
 103                 const char *description);
 104
 105 extern int bt_component_class_set_help(
 106                 struct bt_component_class *component_class,
 107                 const char *help);
 108
 109 extern int bt_component_class_freeze(
 110                 struct bt_component_class *component_class);
 111
 112 /**
 113  * Get a component class' name.
 114  *
 115  * @param component_class       Component class of which to get the name
 116  * @returns                     Name of the component class
 117  */
 118 extern const char *bt_component_class_get_name(
 119                 struct bt_component_class *component_class);
 120
 121 /**
 122  * Get a component class' description.
 123  *
 124  * Component classes may provide an optional description. It may, however,
 125  * opt not to.
 126  *
 127  * @param component_class       Component class of which to get the description
 128  * @returns                     Description of the component class, or NULL.
 129  */
 130 extern const char *bt_component_class_get_description(
 131                 struct bt_component_class *component_class);
 132
 133 extern const char *bt_component_class_get_help(
 134                 struct bt_component_class *component_class);
 135
 136 extern int bt_component_class_set_query_method(
 137                 struct bt_component_class *component_class,
 138                 bt_component_class_query_method query_method);
 139
 140 extern int bt_component_class_set_new_connection_method(
 141                 struct bt_component_class *component_class,
 142                 bt_component_class_new_connection_method new_connection_method);
 143
 144 extern struct bt_value *bt_component_class_query(
 145                 struct bt_component_class *component_class,
 146                 const char *object, struct bt_value *params);
 147
 148 /**
 149  * Get a component class' type.
 150  *
 151  * @param component_class       Component class of which to get the type
 152  * @returns                     One of #bt_component_type
 153  */
 154 extern enum bt_component_class_type bt_component_class_get_type(
 155                 struct bt_component_class *component_class);
 156
 157 #ifdef __cplusplus
 158 }
 159 #endif
 160
 161 #endif /* BABELTRACE_COMPONENT_COMPONENT_CLASS_H */