-restrictions on using GNUNET_LOCKMANAGER_cancel_request()
authorSree Harsha Totakura <totakura@in.tum.de>
Wed, 20 Jun 2012 10:04:36 +0000 (10:04 +0000)
committerSree Harsha Totakura <totakura@in.tum.de>
Wed, 20 Jun 2012 10:04:36 +0000 (10:04 +0000)
src/include/gnunet_lockmanager_service.h

index 570cce56566e45dd557b9c638f0c91f0de19ed42..f0863afdd29846c31b41896c01051749be822bf9 100644 (file)
@@ -92,7 +92,9 @@ enum GNUNET_LOCKMANAGER_Status
  * @param lock the lock for which this status is relevant
  *
  * @param status GNUNET_LOCKMANAGER_SUCCESS if the lock has been successfully
- *          acquired; GNUNET_LOCKMANAGER_RELEASE when the acquired lock is lost
+ *          acquired; GNUNET_LOCKMANAGER_RELEASE when the acquired lock is
+ *          lost. GNUNET_LOCKMANAGER_cancel_request must NOT be called in this
+ *          callback when status == GNUNET_LOCKMANAGER_RELEASE
  */
 typedef void 
 (*GNUNET_LOCKMANAGER_StatusCallback) (void *cls,
@@ -142,8 +144,8 @@ GNUNET_LOCKMANAGER_acquire_lock (struct GNUNET_LOCKMANAGER_Handle *handle,
 
 /**
  * Function to cancel the locking request generated by
- * GNUNET_LOCKMANAGER_acquire_lock. If the lock is acquired us then the lock is
- * released. GNUNET_LOCKMANAGER_StatusCallback will not be called upon any
+ * GNUNET_LOCKMANAGER_acquire_lock. If the lock is acquired by us then the lock
+ * is released. GNUNET_LOCKMANAGER_StatusCallback will not be called upon any
  * status changes resulting due to this call.
  *
  * @param request the LockingRequest to cancel