- document tunnel internal API

- change iterator parameter order

3 files changed, 58 insertions, 5 deletions

diff --git a/src/mesh/gnunet-service-mesh_local.c b/src/mesh/gnunet-service-mesh_local.c
index a02ef84c8..b1f974b41 100644
--- a/src/mesh/gnunet-service-mesh_local.c
+++ b/src/mesh/gnunet-service-mesh_local.c
@@ -589,7 +589,7 @@ handle_ack (void *cls, struct GNUNET_SERVER_Client *client,
  * @return #GNUNET_YES, to keep iterating.
  */
 static int
-monitor_all_tunnels_iterator (void *cls,
+get_all_tunnels_iterator (void *cls,
                               const struct GNUNET_PeerIdentity * peer,
                               void *value)
 {
@@ -640,7 +640,7 @@ handle_get_tunnels (void *cls, struct GNUNET_SERVER_Client *client,
        "Received get tunnels request from client %u (%p)\n",
        c->id, client);
 
-  GMT_iterate_all (client, monitor_all_tunnels_iterator);
+  GMT_iterate_all (get_all_tunnels_iterator, client);
   reply.size = htons (sizeof (reply));
   reply.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_INFO_TUNNELS);
   GNUNET_SERVER_notification_context_unicast (nc, client, &reply, GNUNET_NO);
diff --git a/src/mesh/gnunet-service-mesh_tunnel.c b/src/mesh/gnunet-service-mesh_tunnel.c
index 30d3408e9..e5ca08828 100644
--- a/src/mesh/gnunet-service-mesh_tunnel.c
+++ b/src/mesh/gnunet-service-mesh_tunnel.c
@@ -2631,7 +2631,7 @@ GMT_2s (const struct MeshTunnel3 *t)
 
 
 /**
- * Log all possible info about the tunnel state.
+ * Log all possible info about the tunnel state to stderr.
  *
  * @param t Tunnel to debug.
  */
@@ -2671,18 +2671,38 @@ GMT_debug (const struct MeshTunnel3 *t)
 }
 
 
+/**
+ * Iterate all tunnels.
+ *
+ * @param iter Iterator.
+ * @param cls Closure for @c iter.
+ */
 void
-GMT_iterate_all (void *cls, GNUNET_CONTAINER_PeerMapIterator iter)
+GMT_iterate_all (GNUNET_CONTAINER_PeerMapIterator iter, void *cls)
 {
   GNUNET_CONTAINER_multipeermap_iterate (tunnels, iter, cls);
 }
 
+
+/**
+ * Count all tunnels.
+ *
+ * @return Number of tunnels to remote peers kept by this peer.
+ */
 unsigned int
 GMT_count_all (void)
 {
   return GNUNET_CONTAINER_multipeermap_size (tunnels);
 }
 
+
+/**
+ * Iterate all connections of a tunnel.
+ *
+ * @param t Tunnel whose connections to iterate.
+ * @param iter Iterator.
+ * @param cls Closure for @c iter.
+ */
 void
 GMT_iterate_connections (struct MeshTunnel3 *t, GMT_conn_iter iter, void *cls)
 {
@@ -2692,6 +2712,14 @@ GMT_iterate_connections (struct MeshTunnel3 *t, GMT_conn_iter iter, void *cls)
     iter (cls, ct->c);
 }
 
+
+/**
+ * Iterate all channels of a tunnel.
+ *
+ * @param t Tunnel whose channels to iterate.
+ * @param iter Iterator.
+ * @param cls Closure for @c iter.
+ */
 void
 GMT_iterate_channels (struct MeshTunnel3 *t, GMT_chan_iter iter, void *cls)
 {
diff --git a/src/mesh/gnunet-service-mesh_tunnel.h b/src/mesh/gnunet-service-mesh_tunnel.h
index afa12aa6a..6ade6f866 100644
--- a/src/mesh/gnunet-service-mesh_tunnel.h
+++ b/src/mesh/gnunet-service-mesh_tunnel.h
@@ -481,15 +481,40 @@ GMT_2s (const struct MeshTunnel3 *t);
 void
 GMT_debug (const struct MeshTunnel3 *t);
 
+/**
+ * Iterate all tunnels.
+ *
+ * @param iter Iterator.
+ * @param cls Closure for @c iter.
+ */
 void
-GMT_iterate_all (void *cls, GNUNET_CONTAINER_PeerMapIterator iter);
+GMT_iterate_all (GNUNET_CONTAINER_PeerMapIterator iter, void *cls);
 
+/**
+ * Count all tunnels.
+ *
+ * @return Number of tunnels to remote peers kept by this peer.
+ */
 unsigned int
 GMT_count_all (void);
 
+/**
+ * Iterate all connections of a tunnel.
+ *
+ * @param t Tunnel whose connections to iterate.
+ * @param iter Iterator.
+ * @param cls Closure for @c iter.
+ */
 void
 GMT_iterate_connections (struct MeshTunnel3 *t, GMT_conn_iter iter, void *cls);
 
+/**
+ * Iterate all channels of a tunnel.
+ *
+ * @param t Tunnel whose channels to iterate.
+ * @param iter Iterator.
+ * @param cls Closure for @c iter.
+ */
 void
 GMT_iterate_channels (struct MeshTunnel3 *t, GMT_chan_iter iter, void *cls);