[GNUnet-SVN] r33994 - gnunet/src/cadet

[gnunet]

Author: bartpolot
Date: 2014-07-21 02:15:21 +0200 (Mon, 21 Jul 2014)
New Revision: 33994

Modified:
   gnunet/src/cadet/gnunet-service-cadet_connection.c
   gnunet/src/cadet/gnunet-service-cadet_peer.c
   gnunet/src/cadet/gnunet-service-cadet_peer.h
Log:
- doxygen, code formatting

Modified: gnunet/src/cadet/gnunet-service-cadet_connection.c
===================================================================
--- gnunet/src/cadet/gnunet-service-cadet_connection.c  2014-07-21 00:15:19 UTC 
(rev 33993)
+++ gnunet/src/cadet/gnunet-service-cadet_connection.c  2014-07-21 00:15:21 UTC 
(rev 33994)
@@ -1114,13 +1114,12 @@
 {
   struct CadetPeer *peer;
 
-  LOG (GNUNET_ERROR_TYPE_DEBUG,
-              "connection_unlock_queue %s on %s\n",
-              GC_f2s (fwd), GCC_2s (c));
+  LOG (GNUNET_ERROR_TYPE_DEBUG, "connection_unlock_queue %s on %s\n",
+       GC_f2s (fwd), GCC_2s (c));
 
   if (GCC_is_terminal (c, fwd))
   {
-    LOG (GNUNET_ERROR_TYPE_DEBUG, " is terminal!\n");
+    LOG (GNUNET_ERROR_TYPE_DEBUG, " is terminal, can unlock!\n");
     return;
   }
 

Modified: gnunet/src/cadet/gnunet-service-cadet_peer.c
===================================================================
--- gnunet/src/cadet/gnunet-service-cadet_peer.c        2014-07-21 00:15:19 UTC 
(rev 33993)
+++ gnunet/src/cadet/gnunet-service-cadet_peer.c        2014-07-21 00:15:21 UTC 
(rev 33994)
@@ -1428,7 +1428,16 @@
   return NULL;
 }
 
-
+/**
+ * Unlock a possibly locked queue for a connection.
+ *
+ * If there is a message that can be sent on this connection, call core for it.
+ * Otherwise (if core transmit is already called or there is no sendable
+ * message) do nothing.
+ *
+ * @param peer Peer who keeps the queue.
+ * @param c Connection whose messages to unlock.
+ */
 void
 GCP_queue_unlock (struct CadetPeer *peer, struct CadetConnection *c)
 {

Modified: gnunet/src/cadet/gnunet-service-cadet_peer.h
===================================================================
--- gnunet/src/cadet/gnunet-service-cadet_peer.h        2014-07-21 00:15:19 UTC 
(rev 33993)
+++ gnunet/src/cadet/gnunet-service-cadet_peer.h        2014-07-21 00:15:21 UTC 
(rev 33994)
@@ -169,6 +169,10 @@
 /**
  * Get the first message for a connection and unqueue it.
  *
+ * If the message was the last in the connection and the destruction flag
+ * was set, the connection will be freed by the continuation called by this
+ * function, and @c c will be INVALID after the call.
+ *
  * @param peer Neighboring peer.
  * @param c Connection.
  *
@@ -177,6 +181,16 @@
 struct GNUNET_MessageHeader *
 GCP_connection_pop (struct CadetPeer *peer, struct CadetConnection *c);
 
+/**
+ * Unlock a possibly locked queue for a connection.
+ *
+ * If there is a message that can be sent on this connection, call core for it.
+ * Otherwise (if core transmit is already called or there is no sendable
+ * message) do nothing.
+ *
+ * @param peer Peer who keeps the queue.
+ * @param c Connection whose messages to unlock.
+ */
 void
 GCP_queue_unlock (struct CadetPeer *peer, struct CadetConnection *c);