include/babeltrace/plugin/component.h

   1 #ifndef BABELTRACE_PLUGIN_COMPONENT_H
   2 #define BABELTRACE_PLUGIN_COMPONENT_H
   3
   4 /*
   5  * BabelTrace - Babeltrace Component Interface
   6  *
   7  * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   8  *
   9  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  10  *
  11  * Permission is hereby granted, free of charge, to any person obtaining a copy
  12  * of this software and associated documentation files (the "Software"), to deal
  13  * in the Software without restriction, including without limitation the rights
  14  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  15  * copies of the Software, and to permit persons to whom the Software is
  16  * furnished to do so, subject to the following conditions:
  17  *
  18  * The above copyright notice and this permission notice shall be included in
  19  * all copies or substantial portions of the Software.
  20  *
  21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  24  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  26  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  */
  29
  30 #include <babeltrace/plugin/component-class.h>
  31 #include <babeltrace/values.h>
  32 #include <stdio.h>
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 /**
  39  * Status code. Errors are always negative.
  40  */
  41 enum bt_component_status {
  42         /** No error, okay. */
  43         BT_COMPONENT_STATUS_OK =                0,
  44         /** General error. */
  45         BT_COMPONENT_STATUS_ERROR =             -1,
  46         /** Unsupported component feature. */
  47         BT_COMPONENT_STATUS_UNSUPPORTED =       -2,
  48         /** Invalid arguments. */
  49         BT_COMPONENT_STATUS_INVALID =           -3,
  50         /** Memory allocation failure. */
  51         BT_COMPONENT_STATUS_NOMEM =             -4,
  52 };
  53
  54 struct bt_component;
  55 struct bt_value;
  56
  57 /**
  58  * Create an instance of a component from a component class.
  59  *
  60  * @param component_class       Component class of which to create an instance
  61  * @param name                  Name of the new component instance, optional
  62  * @param params                A dictionary of component parameters
  63  * @returns                     Returns a pointer to a new component instance
  64  */
  65 extern struct bt_component *bt_component_create(
  66                 struct bt_component_class *component_class, const char *name,
  67                 struct bt_value *params);
  68
  69 /**
  70  * Get component's name.
  71  *
  72  * @param component     Component instance of which to get the name
  73  * @returns             Returns a pointer to the component's name
  74  */
  75 extern const char *bt_component_get_name(struct bt_component *component);
  76
  77 /**
  78  * Set component's name.
  79  *
  80  * @param component     Component instance of which to set the name
  81  * @param name          New component name (will be copied)
  82  * @returns             One of #bt_component_status values
  83  */
  84 extern enum bt_component_status bt_component_set_name(
  85                 struct bt_component *component, const char *name);
  86
  87 /**
  88  * Get component's class.
  89  *
  90  * @param component     Component instance of which to get the class
  91  * @returns             The component's class
  92  */
  93 extern struct bt_component_class *bt_component_get_class(
  94                 struct bt_component *component);
  95
  96 #ifdef __cplusplus
  97 }
  98 #endif
  99
 100 #endif /* BABELTRACE_PLUGIN_COMPONENT_H */