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         /** No more work to be done by this component. **/
  45         BT_COMPONENT_STATUS_END =               1,
  46         /**
  47          * Component can't process a notification at this time
  48          * (e.g. would block), try again later.
  49          */
  50         BT_COMPONENT_STATUS_AGAIN =             2,
  51         /** General error. */
  52         BT_COMPONENT_STATUS_ERROR =             -1,
  53         /** Unsupported component feature. */
  54         BT_COMPONENT_STATUS_UNSUPPORTED =       -2,
  55         /** Invalid arguments. */
  56         BT_COMPONENT_STATUS_INVALID =           -3,
  57         /** Memory allocation failure. */
  58         BT_COMPONENT_STATUS_NOMEM =             -4,
  59 };
  60
  61 struct bt_component;
  62 struct bt_value;
  63
  64 /**
  65  * Create an instance of a component from a component class.
  66  *
  67  * @param component_class       Component class of which to create an instance
  68  * @param name                  Name of the new component instance, optional
  69  * @param params                A dictionary of component parameters
  70  * @returns                     Returns a pointer to a new component instance
  71  */
  72 extern struct bt_component *bt_component_create(
  73                 struct bt_component_class *component_class, const char *name,
  74                 struct bt_value *params);
  75
  76 /**
  77  * Get component's name.
  78  *
  79  * @param component     Component instance of which to get the name
  80  * @returns             Returns a pointer to the component's name
  81  */
  82 extern const char *bt_component_get_name(struct bt_component *component);
  83
  84 /**
  85  * Set component's name.
  86  *
  87  * @param component     Component instance of which to set the name
  88  * @param name          New component name (will be copied)
  89  * @returns             One of #bt_component_status values
  90  */
  91 extern enum bt_component_status bt_component_set_name(
  92                 struct bt_component *component, const char *name);
  93
  94 /**
  95  * Get component's class.
  96  *
  97  * @param component     Component instance of which to get the class
  98  * @returns             The component's class
  99  */
 100 extern struct bt_component_class *bt_component_get_class(
 101                 struct bt_component *component);
 102
 103 #ifdef __cplusplus
 104 }
 105 #endif
 106
 107 #endif /* BABELTRACE_PLUGIN_COMPONENT_H */