include/babeltrace/component/component-source-internal.h

   1 #ifndef BABELTRACE_COMPONENT_SOURCE_INTERNAL_H
   2 #define BABELTRACE_COMPONENT_SOURCE_INTERNAL_H
   3
   4 /*
   5  * BabelTrace - Source Component internal
   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/babeltrace-internal.h>
  31 #include <babeltrace/component/component-internal.h>
  32 #include <babeltrace/component/component-class-internal.h>
  33
  34 struct bt_value;
  35
  36 struct bt_component_source {
  37         struct bt_component parent;
  38 };
  39
  40 /**
  41  * Allocate a source component.
  42  *
  43  * @param class                 Component class
  44  * @param params                A dictionary of component parameters
  45  * @returns                     A source component instance
  46  */
  47 BT_HIDDEN
  48 struct bt_component *bt_component_source_create(
  49                 struct bt_component_class *class, struct bt_value *params);
  50
  51 BT_HIDDEN
  52 void bt_component_source_destroy(struct bt_component *component);
  53
  54 /**
  55  * Validate a source component.
  56  *
  57  * @param component             Source component instance to validate
  58  * @returns                     One of #bt_component_status
  59  */
  60 BT_HIDDEN
  61 enum bt_component_status bt_component_source_validate(
  62                 struct bt_component *component);
  63
  64 #endif /* BABELTRACE_COMPONENT_SOURCE_INTERNAL_H */