[GNUnet-SVN] r27483 - gnunet/src/include

[gnunet]

Author: bartpolot
Date: 2013-06-19 11:28:45 +0200 (Wed, 19 Jun 2013)
New Revision: 27483

Modified:
   gnunet/src/include/gnunet_mesh2_service.h
Log:
- document bug #2896: domunet tunnel_destroy behavior

Modified: gnunet/src/include/gnunet_mesh2_service.h
===================================================================
--- gnunet/src/include/gnunet_mesh2_service.h   2013-06-19 09:25:37 UTC (rev 
27482)
+++ gnunet/src/include/gnunet_mesh2_service.h   2013-06-19 09:28:45 UTC (rev 
27483)
@@ -206,10 +206,13 @@
 
 
 /**
- * Destroy an existing tunnel. The existing end callback for the tunnel will
- * be called.
+ * Destroy an existing tunnel.
+ * 
+ * The existing end callback for the tunnel will be called immediately.
+ * Any pending outgoing messages will be sent but no incoming messages will be
+ * accepted and no data callbacks will be called.
  *
- * @param tunnel tunnel handle
+ * @param tunnel Tunnel handle, becomes invalid after this call.
  */
 void
 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tunnel);