[GNUnet-SVN] r22284 - gnunet/src/transport

[gnunet]

Author: grothoff
Date: 2012-06-26 13:27:08 +0200 (Tue, 26 Jun 2012)
New Revision: 22284

Modified:
   gnunet/src/transport/gnunet-service-transport_neighbours.c
Log:
-clarify comments

Modified: gnunet/src/transport/gnunet-service-transport_neighbours.c
===================================================================
--- gnunet/src/transport/gnunet-service-transport_neighbours.c  2012-06-25 
22:36:56 UTC (rev 22283)
+++ gnunet/src/transport/gnunet-service-transport_neighbours.c  2012-06-26 
11:27:08 UTC (rev 22284)
@@ -368,7 +368,13 @@
   S_DISCONNECT,
 
   /**
-   * We're finished with the disconnect; clean up state now!
+   * We're finished with the disconnect; and are cleaning up the state
+   * now!  We put the struct into this state when we are really in the
+   * task that calls 'free' on it and are about to remove the record
+   * from the map.  We should never find a 'struct NeighbourMapEntry'
+   * in this state in the map.  Accessing a 'struct NeighbourMapEntry'
+   * in this state virtually always means using memory that has been
+   * freed (the exception being the cleanup code in 'free_neighbour').
    */
   S_DISCONNECT_FINISHED
 };