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/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         void (*destroy)(struct bt_component *);
  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         /* Input and output ports (weak references) */
  62         GPtrArray *input_ports;
  63         GPtrArray *output_ports;
  64 };
  65
  66 static inline
  67 struct bt_component *bt_component_from_private(
  68                 struct bt_private_component *private_component)
  69 {
  70         return (void *) private_component;
  71 }
  72
  73 static inline
  74 struct bt_private_component *bt_private_component_from_component(
  75                 struct bt_component *component)
  76 {
  77         return (void *) component;
  78 }
  79
  80 BT_HIDDEN
  81 enum bt_component_status bt_component_accept_port_connection(
  82                 struct bt_component *component, struct bt_port *self_port);
  83
  84 BT_HIDDEN
  85 void bt_component_port_disconnected(struct bt_component *comp,
  86                 struct bt_port *port);
  87
  88 BT_HIDDEN
  89 void bt_component_set_graph(struct bt_component *component,
  90                 struct bt_graph *graph);
  91
  92 BT_HIDDEN
  93 uint64_t bt_component_get_input_port_count(struct bt_component *comp);
  94
  95 BT_HIDDEN
  96 uint64_t bt_component_get_output_port_count(struct bt_component *comp);
  97
  98 BT_HIDDEN
  99 struct bt_port *bt_component_get_input_port_at_index(struct bt_component *comp,
 100                 int index);
 101
 102 BT_HIDDEN
 103 struct bt_port *bt_component_get_output_port_at_index(struct bt_component *comp,
 104                 int index);
 105
 106 BT_HIDDEN
 107 struct bt_port *bt_component_get_input_port(struct bt_component *comp,
 108                 const char *name);
 109
 110 BT_HIDDEN
 111 struct bt_port *bt_component_get_output_port(struct bt_component *comp,
 112                 const char *name);
 113
 114 BT_HIDDEN
 115 struct bt_port *bt_component_add_input_port(
 116                 struct bt_component *component, const char *name);
 117
 118 BT_HIDDEN
 119 struct bt_port *bt_component_add_output_port(
 120                 struct bt_component *component, const char *name);
 121
 122 BT_HIDDEN
 123 enum bt_component_status bt_component_remove_port(
 124                 struct bt_component *component, struct bt_port *port);
 125
 126 #endif /* BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H */