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 <glib.h>
  39
  40 struct bt_component_class;
  41
  42 typedef void (*bt_component_class_destroy_listener_func)(
  43                 struct bt_component_class *class, void *data);
  44
  45 struct bt_component_class_destroy_listener {
  46         bt_component_class_destroy_listener_func func;
  47         void *data;
  48 };
  49
  50 struct bt_component_class {
  51         struct bt_object base;
  52         enum bt_component_class_type type;
  53         GString *name;
  54         GString *description;
  55         struct {
  56                 bt_component_class_init_method init;
  57                 bt_component_class_destroy_method destroy;
  58         } methods;
  59         /* Array of struct bt_component_class_destroy_listener */
  60         GArray *destroy_listeners;
  61 };
  62
  63 struct bt_component_class_source {
  64         struct bt_component_class parent;
  65         struct {
  66                 bt_component_class_source_init_iterator_method init_iterator;
  67         } methods;
  68 };
  69
  70 struct bt_component_class_sink {
  71         struct bt_component_class parent;
  72         struct {
  73                 bt_component_class_sink_consume_method consume;
  74                 bt_component_class_sink_add_iterator_method add_iterator;
  75         } methods;
  76 };
  77
  78 struct bt_component_class_filter {
  79         struct bt_component_class parent;
  80         struct {
  81                 bt_component_class_filter_init_iterator_method init_iterator;
  82                 bt_component_class_filter_add_iterator_method add_iterator;
  83         } methods;
  84 };
  85
  86 BT_HIDDEN
  87 int bt_component_class_add_destroy_listener(struct bt_component_class *class,
  88                 bt_component_class_destroy_listener_func func, void *data);
  89
  90 #endif /* BABELTRACE_COMPONENT_COMPONENT_CLASS_INTERNAL_H */