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_plugin;
  35 struct bt_component_class;
  36
  37 extern struct bt_component_class *bt_component_class_create(
  38                 enum bt_component_type type, const char *name,
  39                 const char *description, bt_component_init_cb init);
  40
  41 /**
  42  * Get a component class' name.
  43  *
  44  * @param component_class       Component class of which to get the name
  45  * @returns                     Name of the component class
  46  */
  47 extern const char *bt_component_class_get_name(
  48                 struct bt_component_class *component_class);
  49
  50 /**
  51  * Get a component class' description.
  52  *
  53  * Component classes may provide an optional description. It may, however,
  54  * opt not to.
  55  *
  56  * @param component_class       Component class of which to get the description
  57  * @returns                     Description of the component class, or NULL.
  58  */
  59 extern const char *bt_component_class_get_description(
  60                 struct bt_component_class *component_class);
  61
  62 /**
  63  * Get a component class' type.
  64  *
  65  * @param component_class       Component class of which to get the type
  66  * @returns                     One of #bt_component_type
  67  */
  68 extern enum bt_component_type bt_component_class_get_type(
  69                 struct bt_component_class *component_class);
  70
  71 #endif /* BABELTRACE_COMPONENT_COMPONENT_CLASS_H */