Add base plug-in skeletons

[babeltrace.git] / include / babeltrace / plugin / component-class.h

diff --git a/include/babeltrace/plugin/component-class.h b/include/babeltrace/plugin/component-class.h
index 850f5e8516507ef1964353b8cc29a48c410243d1..1526e4cb810042f63d0d24635780bd5739971041 100644 (file)
--- a/include/babeltrace/plugin/component-class.h
+++ b/include/babeltrace/plugin/component-class.h
@@ -45,12 +45,47 @@ enum bt_component_type {
        BT_COMPONENT_TYPE_FILTER =      2,
 };
 
+struct bt_plugin;
 struct bt_component_class;
 
-const char *bt_component_class_get_name(
+
+/**
+ * Get a component class' name.
+ *
+ * @param component_class      Component class of which to get the name
+ * @returns                    Name of the component class
+ */
+extern const char *bt_component_class_get_name(
+               struct bt_component_class *component_class);
+
+/**
+ * Get a component class' description.
+ *
+ * Component classes may provide an optional description. It may, however,
+ * opt not to.
+ *
+ * @param component_class      Component class of which to get the description
+ * @returns                    Description of the component class, or NULL.
+ */
+extern const char *bt_component_class_get_description(
                struct bt_component_class *component_class);
 
-enum bt_component_type bt_component_class_get_type(
+/**
+ * Get a component class' type.
+ *
+ * @param component_class      Component class of which to get the type
+ * @returns                    One of #bt_component_type
+ */
+extern enum bt_component_type bt_component_class_get_type(
+               struct bt_component_class *component_class);
+
+/**
+ * Get a component class' plug-in.
+ *
+ * @param component_class      Component class of which to get the plug-in
+ * @returns                    The plug-in which registered the component class
+ */
+extern struct bt_plugin *bt_component_class_get_plugin(
                struct bt_component_class *component_class);
 
 #endif /* BABELTRACE_PLUGIN_COMPONENT_CLASS_H */