include/babeltrace/plugin/component-factory.h

   1 #ifndef BABELTRACE_PLUGIN_COMPONENT_FACTORY_H
   2 #define BABELTRACE_PLUGIN_COMPONENT_FACTORY_H
   3
   4 /*
   5  * Babeltrace - Component Factory Class Interface.
   6  *
   7  * Copyright 2015 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/plugin/component.h>
  29 #include <babeltrace/plugin/source.h>
  30 #include <babeltrace/plugin/sink.h>
  31 #include <babeltrace/plugin/filter.h>
  32 #include <babeltrace/plugin/plugin-system.h>
  33 #include <babeltrace/values.h>
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 /**
  40  * Status code. Errors are always negative.
  41  */
  42 enum bt_component_factory_status {
  43         /** General error. */
  44         BT_COMPONENT_FACTORY_STATUS_ERROR =             -128,
  45
  46         /** Invalid plugin. */
  47         BT_COMPONENT_FACTORY_STATUS_INVAL_PLUGIN =      -6,
  48
  49         /** Invalid arguments. */
  50         BT_COMPONENT_FACTORY_STATUS_INVAL =             -5,
  51
  52         /** Memory allocation failure. */
  53         BT_COMPONENT_FACTORY_STATUS_NOMEM =             -4,
  54
  55         /** I/O error. */
  56         BT_COMPONENT_FACTORY_STATUS_IO =                -3,
  57
  58         /** No such file or directory. */
  59         BT_COMPONENT_FACTORY_STATUS_NOENT =             -2,
  60
  61         /** Operation not permitted. */
  62         BT_COMPONENT_FACTORY_STATUS_PERM =              -1,
  63
  64         /** No error, okay. */
  65         BT_COMPONENT_FACTORY_STATUS_OK =                0,
  66 };
  67
  68 struct bt_component_factory;
  69
  70 /**
  71  * Create a component factory.
  72  *
  73  * @returns     An instance of component factory
  74  */
  75 extern struct bt_component_factory *bt_component_factory_create(void);
  76
  77 /**
  78  * Get the list of components registered to this factory.
  79  */
  80 extern struct bt_value *bt_component_factory_get_components(
  81                 struct bt_component_factory *factory);
  82
  83 /**
  84  * Recursively load and register Babeltrace plugins under a given path.
  85  *
  86  * Path will be traversed recursively if it is a directory, otherwise only the
  87  * provided file will be loaded.
  88  *
  89  * @param factory       A component factory instance
  90  * @param path          A path to a file or directory
  91  * @returns             One of #bt_component_factory_status values
  92  */
  93 extern enum bt_component_factory_status bt_component_factory_load(
  94                 struct bt_component_factory *factory, const char *path);
  95
  96 extern enum bt_component_factory_status
  97 bt_component_factory_register_source_component_class(
  98                 struct bt_component_factory *factory, const char *name,
  99                 bt_component_source_init_cb init);
 100
 101 extern enum bt_component_factory_status
 102 bt_component_factory_register_sink_component_class(
 103                 struct bt_component_factory *factory, const char *name,
 104                 bt_component_sink_init_cb init);
 105
 106 #ifdef __cplusplus
 107 }
 108 #endif
 109
 110 #endif /* BABELTRACE_PLUGIN_COMPONENT_FACTORY_H */