prrwlock.h
上传用户:goldcmy89
上传日期:2017-12-03
资源大小:2246k
文件大小:4k
源码类别:

PlugIns编程

开发平台:

Visual C++

  1. /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is the Netscape Portable Runtime (NSPR).
  16.  *
  17.  * The Initial Developer of the Original Code is
  18.  * Netscape Communications Corporation.
  19.  * Portions created by the Initial Developer are Copyright (C) 1998-2000
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  *
  24.  * Alternatively, the contents of this file may be used under the terms of
  25.  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26.  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27.  * in which case the provisions of the GPL or the LGPL are applicable instead
  28.  * of those above. If you wish to allow use of your version of this file only
  29.  * under the terms of either the GPL or the LGPL, and not to allow others to
  30.  * use your version of this file under the terms of the MPL, indicate your
  31.  * decision by deleting the provisions above and replace them with the notice
  32.  * and other provisions required by the GPL or the LGPL. If you do not delete
  33.  * the provisions above, a recipient may use your version of this file under
  34.  * the terms of any one of the MPL, the GPL or the LGPL.
  35.  *
  36.  * ***** END LICENSE BLOCK ***** */
  37. /*
  38. ** File: prrwlock.h
  39. ** Description: API to basic reader-writer lock functions of NSPR.
  40. **
  41. **/
  42. #ifndef prrwlock_h___
  43. #define prrwlock_h___
  44. #include "prtypes.h"
  45. PR_BEGIN_EXTERN_C
  46. /*
  47.  * PRRWLock --
  48.  *
  49.  * The reader writer lock, PRRWLock, is an opaque object to the clients
  50.  * of NSPR.  All routines operate on a pointer to this opaque entity.
  51.  */
  52. typedef struct PRRWLock PRRWLock;
  53. #define PR_RWLOCK_RANK_NONE 0
  54. /***********************************************************************
  55. ** FUNCTION:    PR_NewRWLock
  56. ** DESCRIPTION:
  57. **  Returns a pointer to a newly created reader-writer lock object.
  58. ** INPUTS:      Lock rank
  59. ** Lock name
  60. ** OUTPUTS:     void
  61. ** RETURN:      PRRWLock*
  62. **   If the lock cannot be created because of resource constraints, NULL
  63. **   is returned.
  64. **  
  65. ***********************************************************************/
  66. NSPR_API(PRRWLock*) PR_NewRWLock(PRUint32 lock_rank, const char *lock_name);
  67. /***********************************************************************
  68. ** FUNCTION:    PR_DestroyRWLock
  69. ** DESCRIPTION:
  70. **  Destroys a given RW lock object.
  71. ** INPUTS:      PRRWLock *lock - Lock to be freed.
  72. ** OUTPUTS:     void
  73. ** RETURN:      None
  74. ***********************************************************************/
  75. NSPR_API(void) PR_DestroyRWLock(PRRWLock *lock);
  76. /***********************************************************************
  77. ** FUNCTION:    PR_RWLock_Rlock
  78. ** DESCRIPTION:
  79. **  Apply a read lock (non-exclusive) on a RWLock
  80. ** INPUTS:      PRRWLock *lock - Lock to be read-locked.
  81. ** OUTPUTS:     void
  82. ** RETURN:      None
  83. ***********************************************************************/
  84. NSPR_API(void) PR_RWLock_Rlock(PRRWLock *lock);
  85. /***********************************************************************
  86. ** FUNCTION:    PR_RWLock_Wlock
  87. ** DESCRIPTION:
  88. **  Apply a write lock (exclusive) on a RWLock
  89. ** INPUTS:      PRRWLock *lock - Lock to write-locked.
  90. ** OUTPUTS:     void
  91. ** RETURN:      None
  92. ***********************************************************************/
  93. NSPR_API(void) PR_RWLock_Wlock(PRRWLock *lock);
  94. /***********************************************************************
  95. ** FUNCTION:    PR_RWLock_Unlock
  96. ** DESCRIPTION:
  97. **  Release a RW lock. Unlocking an unlocked lock has undefined results.
  98. ** INPUTS:      PRRWLock *lock - Lock to unlocked.
  99. ** OUTPUTS:     void
  100. ** RETURN:      void
  101. ***********************************************************************/
  102. NSPR_API(void) PR_RWLock_Unlock(PRRWLock *lock);
  103. PR_END_EXTERN_C
  104. #endif /* prrwlock_h___ */