include/babeltrace/component/component-internal.h

   1 #ifndef BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H
   2 #define BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H
   3
   4 /*
   5  * BabelTrace - 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.h>
  32 #include <babeltrace/component/component-class-internal.h>
  33 #include <babeltrace/component/component-port-internal.h>
  34 #include <babeltrace/object-internal.h>
  35 #include <glib.h>
  36 #include <stdio.h>
  37
  38 #define DEFAULT_INPUT_PORT_NAME         "default"
  39 #define DEFAULT_OUTPUT_PORT_NAME        "default"
  40
  41 struct bt_component {
  42         struct bt_object base;
  43         struct bt_component_class *class;
  44         GString *name;
  45
  46         /**
  47          * Internal destroy function specific to a source, filter, or
  48          * sink component object.
  49          */
  50         bt_component_class_destroy_method destroy;
  51
  52         /** User-defined data */
  53         void *user_data;
  54
  55         /**
  56          * Used to protect operations which may only be used during
  57          * a component's initialization.
  58          */
  59         bool initializing;
  60 };
  61
  62 BT_HIDDEN
  63 enum bt_component_status bt_component_init(struct bt_component *component,
  64                 bt_component_class_destroy_method destroy);
  65
  66 BT_HIDDEN
  67 struct bt_notification_iterator *bt_component_create_iterator(
  68                 struct bt_component *component, void *init_method_data);
  69
  70 BT_HIDDEN
  71 enum bt_component_status bt_component_new_connection(
  72                 struct bt_component *component, struct bt_port *own_port,
  73                 struct bt_connection *connection);
  74
  75 BT_HIDDEN
  76 void bt_component_set_graph(struct bt_component *component,
  77                 struct bt_graph *graph);
  78
  79 BT_HIDDEN
  80 int bt_component_init_input_ports(struct bt_component *component,
  81                 GPtrArray **input_ports);
  82
  83 BT_HIDDEN
  84 int bt_component_init_output_ports(struct bt_component *component,
  85                 GPtrArray **output_ports);
  86
  87 BT_HIDDEN
  88 struct bt_port *bt_component_get_port(GPtrArray *ports, const char *name);
  89
  90 BT_HIDDEN
  91 struct bt_port *bt_component_get_port_at_index(GPtrArray *ports, int index);
  92
  93 BT_HIDDEN
  94 struct bt_port *bt_component_add_port(
  95                 struct bt_component *component,GPtrArray *ports,
  96                 enum bt_port_type port_type, const char *name);
  97
  98 BT_HIDDEN
  99 enum bt_component_status bt_component_remove_port(
 100                 struct bt_component *component, GPtrArray *ports,
 101                 const char *name);
 102
 103 #endif /* BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H */