You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@apr.apache.org by aa...@apache.org on 2002/02/15 21:10:55 UTC

cvs commit: apr/include apr_lock.h

aaron       02/02/15 12:10:55

  Modified:    .        CHANGES
               include  apr_lock.h
  Log:
  Make a note of our intent to deprecate the apr_lock.h API in the CHANGES
  file, for the sake of APR users who don't keep up with dev@apr.
  
  Also make a similiar note in the doxygen comment for each function
  call in the old lock API. Thanks to Ian Holsman for pointing me to
  the doxygen syntax.
  
  Revision  Changes    Path
  1.223     +5 -0      apr/CHANGES
  
  Index: CHANGES
  ===================================================================
  RCS file: /home/cvs/apr/CHANGES,v
  retrieving revision 1.222
  retrieving revision 1.223
  diff -u -r1.222 -r1.223
  --- CHANGES	15 Feb 2002 08:43:46 -0000	1.222
  +++ CHANGES	15 Feb 2002 20:10:55 -0000	1.223
  @@ -1,5 +1,10 @@
   Changes with APR b1
   
  +  *) Note: We are in the process of deprecating the apr_lock.h API.
  +     The new and improved lock/synchronization APIs now reside
  +     in apr_thread_mutex.h, apr_proc_mutex.h, apr_thread_rwlock.h,
  +     and apr_thread_cond.h.  [Aaron Bannert]
  +
     *) Enable autoconf 2.52{f,g} build support.
        [Blair Zajac <bl...@orcaware.com>]
   
  
  
  
  1.32      +27 -0     apr/include/apr_lock.h
  
  Index: apr_lock.h
  ===================================================================
  RCS file: /home/cvs/apr/include/apr_lock.h,v
  retrieving revision 1.31
  retrieving revision 1.32
  diff -u -r1.31 -r1.32
  --- apr_lock.h	29 Dec 2001 23:14:21 -0000	1.31
  +++ apr_lock.h	15 Feb 2002 20:10:55 -0000	1.32
  @@ -118,6 +118,9 @@
    *          only guaranteed to lock processes.
    * @warning Check APR_HAS_foo_SERIALIZE defines to see if the platform supports
    *          APR_LOCK_foo.  Only APR_LOCK_DEFAULT is portable.
  + * @deprecated CAUTION: This API has been deprecated. The new and expanded
  + * synchronization routines reside in apr_thread_mutex.h, apr_proc_mutex.h,
  + * apr_thread_rwlock.h, and apr_thread_cond.h.
    */
   APR_DECLARE(apr_status_t) apr_lock_create(apr_lock_t **lock,
                                             apr_locktype_e type,
  @@ -129,6 +132,9 @@
   /**
    * Lock a protected region.
    * @param lock The lock to set.
  + * @deprecated CAUTION: This API has been deprecated. The new and expanded
  + * synchronization routines reside in apr_thread_mutex.h, apr_proc_mutex.h,
  + * apr_thread_rwlock.h, and apr_thread_cond.h.
    */
   APR_DECLARE(apr_status_t) apr_lock_acquire(apr_lock_t *lock);
   
  @@ -136,6 +142,9 @@
    * Tries to lock a protected region.  
    * @param lock The lock to set.
    * @return If it fails, returns APR_EBUSY.  Otherwise, it returns APR_SUCCESS.
  + * @deprecated CAUTION: This API has been deprecated. The new and expanded
  + * synchronization routines reside in apr_thread_mutex.h, apr_proc_mutex.h,
  + * apr_thread_rwlock.h, and apr_thread_cond.h.
    */
   APR_DECLARE(apr_status_t) apr_lock_tryacquire(apr_lock_t *lock);
   
  @@ -143,6 +152,9 @@
    * Lock a region with either a reader or writer lock.
    * @param lock The lock to set.
    * @param type The type of lock to acquire.
  + * @deprecated CAUTION: This API has been deprecated. The new and expanded
  + * synchronization routines reside in apr_thread_mutex.h, apr_proc_mutex.h,
  + * apr_thread_rwlock.h, and apr_thread_cond.h.
    */
   APR_DECLARE(apr_status_t) apr_lock_acquire_rw(apr_lock_t *lock,
                                                 apr_readerwriter_e type);
  @@ -150,6 +162,9 @@
   /**
    * Unlock a protected region.
    * @param lock The lock to reset.
  + * @deprecated CAUTION: This API has been deprecated. The new and expanded
  + * synchronization routines reside in apr_thread_mutex.h, apr_proc_mutex.h,
  + * apr_thread_rwlock.h, and apr_thread_cond.h.
    */
   APR_DECLARE(apr_status_t) apr_lock_release(apr_lock_t *lock);
   
  @@ -158,6 +173,9 @@
    * @param lock The lock to free.
    * @remark If the lock is currently active when it is destroyed, it 
    *         will be unlocked first.
  + * @deprecated CAUTION: This API has been deprecated. The new and expanded
  + * synchronization routines reside in apr_thread_mutex.h, apr_proc_mutex.h,
  + * apr_thread_rwlock.h, and apr_thread_cond.h.
    */
   APR_DECLARE(apr_status_t) apr_lock_destroy(apr_lock_t *lock);
   
  @@ -173,6 +191,9 @@
    *         locking mechanism chosen for the platform, but it is a good
    *         idea to call it regardless, because it makes the code more
    *         portable. 
  + * @deprecated CAUTION: This API has been deprecated. The new and expanded
  + * synchronization routines reside in apr_thread_mutex.h, apr_proc_mutex.h,
  + * apr_thread_rwlock.h, and apr_thread_cond.h.
    */
   APR_DECLARE(apr_status_t) apr_lock_child_init(apr_lock_t **lock,
                                                 const char *fname,
  @@ -183,6 +204,9 @@
    * @param lock The currently open lock.
    * @param key The key to use when retreiving data associated with this lock
    * @param data The user data associated with the lock.
  + * @deprecated CAUTION: This API has been deprecated. The new and expanded
  + * synchronization routines reside in apr_thread_mutex.h, apr_proc_mutex.h,
  + * apr_thread_rwlock.h, and apr_thread_cond.h.
    */
   APR_DECLARE(apr_status_t) apr_lock_data_get(apr_lock_t *lock, const char *key,
                                              void *data);
  @@ -193,6 +217,9 @@
    * @param data The user data to associate with the lock.
    * @param key The key to use when associating data with this lock
    * @param cleanup The cleanup to use when the lock is destroyed.
  + * @deprecated CAUTION: This API has been deprecated. The new and expanded
  + * synchronization routines reside in apr_thread_mutex.h, apr_proc_mutex.h,
  + * apr_thread_rwlock.h, and apr_thread_cond.h.
    */
   APR_DECLARE(apr_status_t) apr_lock_data_set(apr_lock_t *lock, void *data,
                                              const char *key,