include/babeltrace/graph/component.h

   1 #ifndef BABELTRACE_GRAPH_COMPONENT_H
   2 #define BABELTRACE_GRAPH_COMPONENT_H
   3
   4 /*
   5  * BabelTrace - Babeltrace Component Interface
   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 /* For BT_COMPONENT_CLASS_TYPE_* */
  31 #include <babeltrace/graph/component-class.h>
  32
  33 /* For bt_bool */
  34 #include <babeltrace/types.h>
  35
  36 /* For bt_object_get_ref */
  37 #include <babeltrace/object.h>
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 struct bt_component_class;
  44 struct bt_component_graph;
  45 struct bt_component;
  46 struct bt_value;
  47 struct bt_port;
  48
  49 /**
  50  * Get component's name.
  51  *
  52  * @param component     Component instance of which to get the name
  53  * @returns             Returns a pointer to the component's name
  54  */
  55 extern const char *bt_component_get_name(struct bt_component *component);
  56
  57 /**
  58  * Get component's class.
  59  *
  60  * @param component     Component instance of which to get the class
  61  * @returns             The component's class
  62  */
  63 extern struct bt_component_class *bt_component_get_class(
  64                 struct bt_component *component);
  65
  66 extern enum bt_component_class_type bt_component_get_class_type(
  67                 struct bt_component *component);
  68
  69 static inline
  70 bt_bool bt_component_is_source(struct bt_component *component)
  71 {
  72         return bt_component_get_class_type(component) ==
  73                 BT_COMPONENT_CLASS_TYPE_SOURCE;
  74 }
  75
  76 static inline
  77 bt_bool bt_component_is_filter(struct bt_component *component)
  78 {
  79         return bt_component_get_class_type(component) ==
  80                 BT_COMPONENT_CLASS_TYPE_FILTER;
  81 }
  82
  83 static inline
  84 bt_bool bt_component_is_sink(struct bt_component *component)
  85 {
  86         return bt_component_get_class_type(component) ==
  87                 BT_COMPONENT_CLASS_TYPE_SINK;
  88 }
  89
  90 extern bt_bool bt_component_graph_is_canceled(struct bt_component *component);
  91
  92 #ifdef __cplusplus
  93 }
  94 #endif
  95
  96 #endif /* BABELTRACE_GRAPH_COMPONENT_H */