Author: adrian.chadd
Date: Sun Apr  5 03:11:01 2009
New Revision: 13917

Modified:
    branches/LUSCA_HEAD/src/store_client.c

Log:
More documentation about the store client event stuff.



Modified: branches/LUSCA_HEAD/src/store_client.c
==============================================================================
--- branches/LUSCA_HEAD/src/store_client.c      (original)
+++ branches/LUSCA_HEAD/src/store_client.c      Sun Apr  5 03:11:01 2009
@@ -264,6 +264,25 @@
      cbdataUnlock(cbdata);
  }

+/*!
+ * @function
+ *     storeClientCopyEvent
+ *
+ * @abstract
+ *     A timed event callback handler; re-attempt the next client copy
+ *
+ * @discussion
+ *     I'm not sure why sc->new_callback would be NULL here; I guess this
+ *     function is attempting to handle the situation where the store client
+ *     has subsequently had the callback occur for whatever reason and
+ *     this event hasn't been removed.
+ *
+ *     The event isn't actually explicitly ever removed - if the store client
+ *     is closed (via a call to storeClientUnregister()) then the store client
+ *     pointer will become invalid and the event won't be called.
+ *     
+ * @param      data    generic pointer containing the store client to check
+ */
  static void
  storeClientCopyEvent(void *data)
  {

--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups 
"lusca-commit" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to 
[email protected]
For more options, visit this group at 
http://groups.google.com/group/lusca-commit?hl=en
-~----------~----~----~----~------~----~------~--~---

Reply via email to