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 /**
  35  * Component type.
  36  */
  37 enum bt_component_type {
  38         BT_COMPONENT_TYPE_UNKNOWN =     -1,
  39
  40         /** A source component is a notification generator. */
  41         BT_COMPONENT_TYPE_SOURCE =      0,
  42
  43         /** A sink component handles incoming notifications. */
  44         BT_COMPONENT_TYPE_SINK =        1,
  45
  46         /** A filter component implements both Source and Sink interfaces. */
  47         BT_COMPONENT_TYPE_FILTER =      2,
  48 };
  49
  50 struct bt_plugin;
  51 struct bt_component_class;
  52
  53 extern struct bt_component_class *bt_component_class_create(
  54                 enum bt_component_type type, const char *name,
  55                 const char *description, bt_component_init_cb init);
  56
  57 /**
  58  * Get a component class' name.
  59  *
  60  * @param component_class       Component class of which to get the name
  61  * @returns                     Name of the component class
  62  */
  63 extern const char *bt_component_class_get_name(
  64                 struct bt_component_class *component_class);
  65
  66 /**
  67  * Get a component class' description.
  68  *
  69  * Component classes may provide an optional description. It may, however,
  70  * opt not to.
  71  *
  72  * @param component_class       Component class of which to get the description
  73  * @returns                     Description of the component class, or NULL.
  74  */
  75 extern const char *bt_component_class_get_description(
  76                 struct bt_component_class *component_class);
  77
  78 /**
  79  * Get a component class' type.
  80  *
  81  * @param component_class       Component class of which to get the type
  82  * @returns                     One of #bt_component_type
  83  */
  84 extern enum bt_component_type bt_component_class_get_type(
  85                 struct bt_component_class *component_class);
  86
  87 #endif /* BABELTRACE_COMPONENT_COMPONENT_CLASS_H */