lib: add sink component class's "graph is configured" method
[babeltrace.git] / include / babeltrace / graph / component-class-sink.h
index 6164c0cc28622362cba1987ef17b4f8f0c236595..601974b9774751edc06f3fe0f33e490a2de2937f 100644 (file)
@@ -2,6 +2,7 @@
 #define BABELTRACE_GRAPH_COMPONENT_CLASS_SINK_H
 
 /*
+ * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
  * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
 
 #include <stdint.h>
 
-/* For enum bt_self_component_status */
+/* For bt_self_component_status */
 #include <babeltrace/graph/self-component.h>
 
-/* For enum bt_query_status */
+/* For bt_query_status */
 #include <babeltrace/graph/component-class.h>
 
+/* For bt_component_class_status */
+#include <babeltrace/graph/component-class-const.h>
+
+/*
+ * For bt_component_class, bt_component_class_sink, bt_port_output,
+ * bt_query_executor, bt_self_component_class_sink,
+ * bt_self_component_sink, bt_self_component_port_input, bt_value
+ */
+#include <babeltrace/types.h>
+
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-struct bt_component_class;
-struct bt_component_class_sink;
-struct bt_port_output;
-struct bt_query_executor;
-struct bt_self_component_class_sink;
-struct bt_self_component_port_input;
-struct bt_self_component_sink;
-struct bt_value;
-
-typedef enum bt_self_component_status
-(*bt_component_class_sink_init_method)(
-               struct bt_self_component_sink *self_component,
-               const struct bt_value *params, void *init_method_data);
+typedef bt_self_component_status (*bt_component_class_sink_init_method)(
+               bt_self_component_sink *self_component,
+               const bt_value *params, void *init_method_data);
 
 typedef void (*bt_component_class_sink_finalize_method)(
-               struct bt_self_component_sink *self_component);
+               bt_self_component_sink *self_component);
 
-typedef enum bt_query_status
+typedef bt_query_status
 (*bt_component_class_sink_query_method)(
-               struct bt_self_component_class_sink *comp_class,
-               const struct bt_query_executor *query_executor,
-               const char *object, const struct bt_value *params,
-               const struct bt_value **result);
+               bt_self_component_class_sink *comp_class,
+               const bt_query_executor *query_executor,
+               const char *object, const bt_value *params,
+               const bt_value **result);
 
-typedef enum bt_self_component_status
+typedef bt_self_component_status
 (*bt_component_class_sink_accept_input_port_connection_method)(
-               struct bt_self_component_sink *self_component,
-               struct bt_self_component_port_input *self_port,
-               const struct bt_port_output *other_port);
+               bt_self_component_sink *self_component,
+               bt_self_component_port_input *self_port,
+               const bt_port_output *other_port);
 
-typedef enum bt_self_component_status
+typedef bt_self_component_status
 (*bt_component_class_sink_input_port_connected_method)(
-               struct bt_self_component_sink *self_component,
-               struct bt_self_component_port_input *self_port,
-               const struct bt_port_output *other_port);
+               bt_self_component_sink *self_component,
+               bt_self_component_port_input *self_port,
+               const bt_port_output *other_port);
 
-typedef void
-(*bt_component_class_sink_input_port_disconnected_method)(
-               struct bt_self_component_sink *self_component,
-               struct bt_self_component_port_input *self_port);
+typedef bt_self_component_status
+(*bt_component_class_sink_graph_is_configured_method)(
+               bt_self_component_sink *self_component);
 
-typedef enum bt_self_component_status
-(*bt_component_class_sink_consume_method)(
-       struct bt_self_component_sink *self_component);
+typedef bt_self_component_status (*bt_component_class_sink_consume_method)(
+       bt_self_component_sink *self_component);
 
 static inline
-struct bt_component_class *bt_component_class_sink_as_component_class(
-               struct bt_component_class_sink *comp_cls_sink)
+bt_component_class *bt_component_class_sink_as_component_class(
+               bt_component_class_sink *comp_cls_sink)
 {
        return (void *) comp_cls_sink;
 }
 
 extern
-struct bt_component_class_sink *bt_component_class_sink_create(
+bt_component_class_sink *bt_component_class_sink_create(
                const char *name,
                bt_component_class_sink_consume_method method);
 
-extern int bt_component_class_sink_set_init_method(
-               struct bt_component_class_sink *comp_class,
+extern bt_component_class_status bt_component_class_sink_set_init_method(
+               bt_component_class_sink *comp_class,
                bt_component_class_sink_init_method method);
 
-extern int bt_component_class_sink_set_finalize_method(
-               struct bt_component_class_sink *comp_class,
+extern bt_component_class_status bt_component_class_sink_set_finalize_method(
+               bt_component_class_sink *comp_class,
                bt_component_class_sink_finalize_method method);
 
-extern int bt_component_class_sink_set_accept_input_port_connection_method(
-               struct bt_component_class_sink *comp_class,
+extern bt_component_class_status
+bt_component_class_sink_set_accept_input_port_connection_method(
+               bt_component_class_sink *comp_class,
                bt_component_class_sink_accept_input_port_connection_method method);
 
-extern int bt_component_class_sink_set_input_port_connected_method(
-               struct bt_component_class_sink *comp_class,
+extern bt_component_class_status
+bt_component_class_sink_set_input_port_connected_method(
+               bt_component_class_sink *comp_class,
                bt_component_class_sink_input_port_connected_method method);
 
-extern int bt_component_class_sink_set_input_port_disconnected_method(
-               struct bt_component_class_sink *comp_class,
-               bt_component_class_sink_input_port_disconnected_method method);
+extern bt_component_class_status
+bt_component_class_sink_set_graph_is_configured_method(
+               bt_component_class_sink *comp_class,
+               bt_component_class_sink_graph_is_configured_method method);
 
-extern int bt_component_class_sink_set_query_method(
-               struct bt_component_class_sink *comp_class,
+extern bt_component_class_status bt_component_class_sink_set_query_method(
+               bt_component_class_sink *comp_class,
                bt_component_class_sink_query_method method);
 
 #ifdef __cplusplus
This page took 0.026558 seconds and 4 git commands to generate.