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

   1 #ifndef BABELTRACE_COMPONENT_COMPONENT_CLASS_INTERNAL_H
   2 #define BABELTRACE_COMPONENT_COMPONENT_CLASS_INTERNAL_H
   3
   4 /*
   5  * BabelTrace - Component Class Internal
   6  *
   7  * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   8  * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
   9  *
  10  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  11  *
  12  * Permission is hereby granted, free of charge, to any person obtaining a copy
  13  * of this software and associated documentation files (the "Software"), to deal
  14  * in the Software without restriction, including without limitation the rights
  15  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  16  * copies of the Software, and to permit persons to whom the Software is
  17  * furnished to do so, subject to the following conditions:
  18  *
  19  * The above copyright notice and this permission notice shall be included in
  20  * all copies or substantial portions of the Software.
  21  *
  22  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  23  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  25  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  26  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  27  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  28  * SOFTWARE.
  29  */
  30
  31 #include <babeltrace/component/component.h>
  32 #include <babeltrace/component/component-class.h>
  33 #include <babeltrace/component/component-class-source.h>
  34 #include <babeltrace/component/component-class-filter.h>
  35 #include <babeltrace/component/component-class-sink.h>
  36 #include <babeltrace/babeltrace-internal.h>
  37 #include <babeltrace/object-internal.h>
  38 #include <stdbool.h>
  39 #include <glib.h>
  40
  41 struct bt_component_class;
  42
  43 typedef void (*bt_component_class_destroy_listener_func)(
  44                 struct bt_component_class *class, void *data);
  45
  46 struct bt_component_class_destroy_listener {
  47         bt_component_class_destroy_listener_func func;
  48         void *data;
  49 };
  50
  51 struct bt_component_class {
  52         struct bt_object base;
  53         enum bt_component_class_type type;
  54         GString *name;
  55         GString *description;
  56         GString *help;
  57         struct {
  58                 bt_component_class_init_method init;
  59                 bt_component_class_finalize_method finalize;
  60                 bt_component_class_query_method query;
  61                 bt_component_class_accept_port_connection_method accept_port_connection;
  62                 bt_component_class_port_disconnected_method port_disconnected;
  63         } methods;
  64         /* Array of struct bt_component_class_destroy_listener */
  65         GArray *destroy_listeners;
  66         bool frozen;
  67 };
  68
  69 struct bt_component_class_iterator_methods {
  70         bt_component_class_notification_iterator_init_method init;
  71         bt_component_class_notification_iterator_finalize_method finalize;
  72         bt_component_class_notification_iterator_get_method get;
  73         bt_component_class_notification_iterator_next_method next;
  74         bt_component_class_notification_iterator_seek_time_method seek_time;
  75 };
  76
  77 struct bt_component_class_source {
  78         struct bt_component_class parent;
  79         struct {
  80                 struct bt_component_class_iterator_methods iterator;
  81         } methods;
  82 };
  83
  84 struct bt_component_class_sink {
  85         struct bt_component_class parent;
  86         struct {
  87                 bt_component_class_sink_consume_method consume;
  88         } methods;
  89 };
  90
  91 struct bt_component_class_filter {
  92         struct bt_component_class parent;
  93         struct {
  94                 struct bt_component_class_iterator_methods iterator;
  95         } methods;
  96 };
  97
  98 BT_HIDDEN
  99 int bt_component_class_add_destroy_listener(struct bt_component_class *class,
 100                 bt_component_class_destroy_listener_func func, void *data);
 101
 102 #endif /* BABELTRACE_COMPONENT_COMPONENT_CLASS_INTERNAL_H */