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
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 struct bt_component_class;
  35
  36 /**
  37  * Component class type.
  38  */
  39 enum bt_component_class_type {
  40         BT_COMPONENT_CLASS_TYPE_UNKNOWN =       -1,
  41
  42         /** A source component is a notification generator. */
  43         BT_COMPONENT_CLASS_TYPE_SOURCE =        0,
  44
  45         /** A sink component handles incoming notifications. */
  46         BT_COMPONENT_CLASS_TYPE_SINK =          1,
  47
  48         /** A filter component implements both Source and Sink interfaces. */
  49         BT_COMPONENT_CLASS_TYPE_FILTER =        2,
  50 };
  51
  52 typedef enum bt_component_status (*bt_component_class_init_method)(
  53                 struct bt_component *component, struct bt_value *params,
  54                 void *init_method_data);
  55
  56 typedef void (*bt_component_class_destroy_method)(struct bt_component *component);
  57
  58 extern int bt_component_class_set_init_method(
  59                 struct bt_component_class *component_class,
  60                 bt_component_class_init_method init_method);
  61
  62 extern int bt_component_class_set_destroy_method(
  63                 struct bt_component_class *component_class,
  64                 bt_component_class_destroy_method destroy_method);
  65
  66 extern int bt_component_class_set_description(
  67                 struct bt_component_class *component_class,
  68                 const char *description);
  69
  70 extern int bt_component_class_freeze(
  71                 struct bt_component_class *component_class);
  72
  73 /**
  74  * Get a component class' name.
  75  *
  76  * @param component_class       Component class of which to get the name
  77  * @returns                     Name of the component class
  78  */
  79 extern const char *bt_component_class_get_name(
  80                 struct bt_component_class *component_class);
  81
  82 /**
  83  * Get a component class' description.
  84  *
  85  * Component classes may provide an optional description. It may, however,
  86  * opt not to.
  87  *
  88  * @param component_class       Component class of which to get the description
  89  * @returns                     Description of the component class, or NULL.
  90  */
  91 extern const char *bt_component_class_get_description(
  92                 struct bt_component_class *component_class);
  93
  94 /**
  95  * Get a component class' type.
  96  *
  97  * @param component_class       Component class of which to get the type
  98  * @returns                     One of #bt_component_type
  99  */
 100 extern enum bt_component_class_type bt_component_class_get_type(
 101                 struct bt_component_class *component_class);
 102
 103 #ifdef __cplusplus
 104 }
 105 #endif
 106
 107 #endif /* BABELTRACE_COMPONENT_COMPONENT_CLASS_H */