code clean up

[oweals/gnunet.git] / src / util / server_nc.c

diff --git a/src/util/server_nc.c b/src/util/server_nc.c
index e9c2f5a3805d599ab2ee87897302706711df33b2..1cf3df8bdc6966b38867b7186eefa283ed45e344 100644 (file)
--- a/src/util/server_nc.c
+++ b/src/util/server_nc.c
@@ -33,33 +33,72 @@
 #include "gnunet_time_lib.h"
 
 
+#define DEBUG_SERVER_NC GNUNET_NO
+
+/**
+ * Entry in list of messages pending to be transmitted.
+ */
 struct PendingMessageList
 {
 
+  /**
+   * This is a linked list.
+   */ 
   struct PendingMessageList *next;
 
+  /**
+   * Message to transmit (allocated at the end of this
+   * struct, do not free)
+   */
   const struct GNUNET_MessageHeader *msg;
 
+  /**
+   * Can this message be dropped?
+   */ 
   int can_drop;
 
 };
 
 
+/**
+ * Lists of clients we manage for notifications.
+ */
 struct ClientList
 {
 
+  /**
+   * This is a linked list.
+   */ 
   struct ClientList *next;
 
+  /**
+   * Overall context this client belongs to. 
+   */
   struct GNUNET_SERVER_NotificationContext *nc;
 
+  /**
+   * Handle to the client.
+   */
   struct GNUNET_SERVER_Client *client;
 
+  /**
+   * Handle for pending transmission request to the client (or NULL).
+   */
   struct GNUNET_CONNECTION_TransmitHandle *th;
 
+  /**
+   * Head of linked list of requests queued for transmission.
+   */ 
   struct PendingMessageList *pending_head;
 
+  /**
+   * Tail of linked list of requests queued for transmission.
+   */ 
   struct PendingMessageList *pending_tail;
 
+  /**
+   * Number of messages currently in the list.
+   */
   unsigned int num_pending;
 
 };
@@ -76,15 +115,30 @@ struct ClientList
 struct GNUNET_SERVER_NotificationContext
 {
 
+  /**
+   * Server we do notifications for.
+   */
   struct GNUNET_SERVER_Handle *server;
 
+  /**
+   * List of clients receiving notifications.
+   */
   struct ClientList *clients;
 
+  /**
+   * Maximum number of optional messages to queue per client.
+   */
   unsigned int queue_length;
 
 };
 
 
+/**
+ * Client has disconnected, clean up.
+ *
+ * @param cls our 'struct GNUNET_SERVER_NotificationContext *'
+ * @param client handle of client that disconnected
+ */
 static void
 handle_client_disconnect (void *cls,
                          struct GNUNET_SERVER_Client *client)
@@ -94,6 +148,11 @@ handle_client_disconnect (void *cls,
   struct ClientList *prev;
   struct PendingMessageList *pml;
 
+  if (client == NULL)
+    {
+      nc->server = NULL;
+      return;
+    }
   prev = NULL;
   pos = nc->clients;
   while (NULL != pos)
@@ -114,6 +173,12 @@ handle_client_disconnect (void *cls,
       pos->pending_head = pml->next;
       GNUNET_free (pml);
     }
+  GNUNET_SERVER_client_drop (client);
+  if (pos->th != NULL)
+    {
+      GNUNET_CONNECTION_notify_transmit_ready_cancel (pos->th);
+      pos->th = NULL;
+    }
   GNUNET_free (pos);
 }
 
@@ -157,8 +222,8 @@ GNUNET_SERVER_notification_context_destroy (struct GNUNET_SERVER_NotificationCon
   while (NULL != (pos = nc->clients))
     {
       nc->clients = pos->next;
-      GNUNET_SERVER_receive_done (pos->client, GNUNET_NO);
       GNUNET_SERVER_client_drop (pos->client); 
+      GNUNET_SERVER_receive_done (pos->client, GNUNET_NO);
       while (NULL != (pml = pos->pending_head))
        {
          pos->pending_head = pml->next;
@@ -166,9 +231,10 @@ GNUNET_SERVER_notification_context_destroy (struct GNUNET_SERVER_NotificationCon
        }
       GNUNET_free (pos);
     }
-  GNUNET_SERVER_disconnect_notify_cancel (nc->server,
-                                         &handle_client_disconnect,
-                                         nc);
+  if (nc->server != NULL)
+    GNUNET_SERVER_disconnect_notify_cancel (nc->server,
+                                           &handle_client_disconnect,
+                                           nc);
   GNUNET_free (nc);
 }
 
@@ -189,6 +255,7 @@ GNUNET_SERVER_notification_context_add (struct GNUNET_SERVER_NotificationContext
   cl->next = nc->clients;
   cl->nc = nc;
   cl->client = client;
+  GNUNET_SERVER_client_keep (client);
   nc->clients = cl;
 }
 
@@ -224,16 +291,23 @@ transmit_message (void *cls,
   while (cl->pending_head != NULL)
     {
       pml = cl->pending_head;
-      cl->pending_head = pml->next;
-      if (pml->next == NULL)
-       cl->pending_tail = NULL;
       msize = ntohs (pml->msg->size);
       if (size < msize)
        break;
+      cl->pending_head = pml->next;
+      if (pml->next == NULL)
+       cl->pending_tail = NULL;
+#if DEBUG_SERVER_NC
+      GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+                 "Copying message of type %u and size %u from pending queue to transmission buffer\n",
+                 ntohs (pml->msg->type),
+                 msize);
+#endif
       memcpy (&cbuf[ret], pml->msg, msize);
       ret += msize;
       size -= msize;
       GNUNET_free (pml);
+      cl->num_pending--;
     }
   if (cl->pending_head != NULL)    
     cl->th = GNUNET_SERVER_notify_transmit_ready (cl->client,
@@ -264,16 +338,31 @@ do_unicast (struct GNUNET_SERVER_NotificationContext *nc,
 
   if ( (client->num_pending > nc->queue_length) &&
        (GNUNET_YES == can_drop) )
-    return; /* drop! */
+    {
+      GNUNET_log (GNUNET_ERROR_TYPE_INFO,
+                 "Dropping message of type %u and size %u due to full queue (%u entries)\n",
+                 ntohs (msg->type),
+                 ntohs (msg->size),
+                 (unsigned int) nc->queue_length);
+      return; /* drop! */
+    }
   if (client->num_pending > nc->queue_length)
     {
       /* FIXME: consider checking for other messages in the
         queue that are 'droppable' */
     }
+  client->num_pending++;
   size = ntohs (msg->size);
   pml = GNUNET_malloc (sizeof (struct PendingMessageList) + size);
   pml->msg = (const struct GNUNET_MessageHeader*) &pml[1];
-  pml->can_drop = can_drop;
+  pml->can_drop = can_drop; 
+#if DEBUG_SERVER_NC
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+             "Adding message of type %u and size %u to pending queue (which has %u entries)\n",
+             ntohs (msg->type),
+             ntohs (msg->size),
+             (unsigned int) nc->queue_length);
+#endif
   memcpy (&pml[1], msg, size);
   /* append */
   if (client->pending_tail != NULL)