include/babeltrace/component/component.h

   1 #ifndef BABELTRACE_COMPONENT_COMPONENT_H
   2 #define BABELTRACE_COMPONENT_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/component/component-class.h>
  31 #include <babeltrace/component/notification/iterator.h>
  32 #include <babeltrace/values.h>
  33 #include <stdio.h>
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 struct bt_component_class;
  40 struct bt_component_graph;
  41 struct bt_component;
  42 struct bt_value;
  43 struct bt_port;
  44
  45 /**
  46  * Status code. Errors are always negative.
  47  */
  48 enum bt_component_status {
  49         /** No error, okay. */
  50         BT_COMPONENT_STATUS_OK                          = 0,
  51         /** No more work to be done by this component. **/
  52         BT_COMPONENT_STATUS_END                         = 1,
  53         /**
  54          * Component can't process a notification at this time
  55          * (e.g. would block), try again later.
  56          */
  57         BT_COMPONENT_STATUS_AGAIN                       = 2,
  58         /** Refuse port connection. */
  59         BT_COMPONENT_STATUS_REFUSE_PORT_CONNECTION      = 3,
  60         /** General error. */
  61         BT_COMPONENT_STATUS_ERROR                       = -1,
  62         /** Unsupported component feature. */
  63         BT_COMPONENT_STATUS_UNSUPPORTED                 = -2,
  64         /** Invalid arguments. */
  65         BT_COMPONENT_STATUS_INVALID                     = -3,
  66         /** Memory allocation failure. */
  67         BT_COMPONENT_STATUS_NOMEM                       = -4,
  68         /** Element not found. */
  69         BT_COMPONENT_STATUS_NOT_FOUND                   = -5,
  70 };
  71
  72 /**
  73  * Create an instance of a component from a component class.
  74  *
  75  * @param component_class       Component class of which to create an instance
  76  * @param name                  Name of the new component instance, optional
  77  * @param params                A dictionary of component parameters
  78  * @returns                     Returns a pointer to a new component instance
  79  */
  80 extern struct bt_component *bt_component_create(
  81                 struct bt_component_class *component_class, const char *name,
  82                 struct bt_value *params);
  83
  84 extern struct bt_component *bt_component_create_with_init_method_data(
  85                 struct bt_component_class *component_class, const char *name,
  86                 struct bt_value *params, void *init_method_data);
  87
  88 /**
  89  * Get component's name.
  90  *
  91  * @param component     Component instance of which to get the name
  92  * @returns             Returns a pointer to the component's name
  93  */
  94 extern const char *bt_component_get_name(struct bt_component *component);
  95
  96 /**
  97  * Get component's class.
  98  *
  99  * @param component     Component instance of which to get the class
 100  * @returns             The component's class
 101  */
 102 extern struct bt_component_class *bt_component_get_class(
 103                 struct bt_component *component);
 104
 105 extern enum bt_component_class_type bt_component_get_class_type(
 106                 struct bt_component *component);
 107
 108 extern struct bt_graph *bt_component_get_graph(struct bt_component *component);
 109
 110 #ifdef __cplusplus
 111 }
 112 #endif
 113
 114 #endif /* BABELTRACE_COMPONENT_COMPONENT_H */