Document libbabeltrace2's C API

[babeltrace.git] / src / lib / graph / connection.c

diff --git a/src/lib/graph/connection.c b/src/lib/graph/connection.c
index 41fbcc6984cb877009bc2d710af1d91b2329fc60..6552b5f2264ea4030a47bee31b1bb3c75241b481 100644 (file)
--- a/src/lib/graph/connection.c
+++ b/src/lib/graph/connection.c
@@ -27,9 +27,10 @@
 #include "common/assert.h"
 #include "lib/assert-pre.h"
 #include "lib/assert-post.h"
-#include <babeltrace2/graph/connection-const.h>
+#include <babeltrace2/graph/connection.h>
 #include "lib/object.h"
 #include "compat/compiler.h"
+#include <stdbool.h>
 #include <stdlib.h>
 #include <glib.h>
 
@@ -50,8 +51,7 @@ void destroy_connection(struct bt_object *obj)
        /*
         * Make sure that each message iterator which was created for
         * this connection is finalized before we destroy it. Once a
-        * message iterator is finalized, all its method return NULL or
-        * the BT_MESSAGE_ITERATOR_STATUS_CANCELED status.
+        * message iterator is finalized, you cannot use it.
         *
         * Because connections are destroyed before components within a
         * graph, this ensures that message iterators are always
@@ -205,12 +205,12 @@ void bt_connection_end(struct bt_connection *conn, bool try_remove_from_graph)
         * which is on graph destruction.
         */
        for (i = 0; i < conn->iterators->len; i++) {
-               struct bt_self_component_port_input_message_iterator *iterator =
+               struct bt_message_iterator *iterator =
                        g_ptr_array_index(conn->iterators, i);
 
                BT_LIB_LOGD("Finalizing message iterator created by "
                        "this ended connection: %![iter-]+i", iterator);
-               bt_self_component_port_input_message_iterator_try_finalize(
+               bt_message_iterator_try_finalize(
                        iterator);
 
                /*
@@ -218,7 +218,7 @@ void bt_connection_end(struct bt_connection *conn, bool try_remove_from_graph)
                 * from this connection's iterators on destruction
                 * because this connection won't exist anymore.
                 */
-               bt_self_component_port_input_message_iterator_set_connection(
+               bt_message_iterator_set_connection(
                        iterator, NULL);
        }
 
@@ -232,20 +232,20 @@ void bt_connection_end(struct bt_connection *conn, bool try_remove_from_graph)
 const struct bt_port_output *bt_connection_borrow_upstream_port_const(
                const struct bt_connection *connection)
 {
-       BT_ASSERT_PRE_NON_NULL(connection, "Connection");
+       BT_ASSERT_PRE_DEV_NON_NULL(connection, "Connection");
        return (void *) connection->upstream_port;
 }
 
 const struct bt_port_input *bt_connection_borrow_downstream_port_const(
                const struct bt_connection *connection)
 {
-       BT_ASSERT_PRE_NON_NULL(connection, "Connection");
+       BT_ASSERT_PRE_DEV_NON_NULL(connection, "Connection");
        return (void *) connection->downstream_port;
 }
 
 BT_HIDDEN
 void bt_connection_remove_iterator(struct bt_connection *conn,
-               struct bt_self_component_port_input_message_iterator *iterator)
+               struct bt_message_iterator *iterator)
 {
        g_ptr_array_remove(conn->iterators, iterator);
        BT_LIB_LOGD("Removed message iterator from connection: "