prlock.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: prlock.h
  39. ** Description: API to basic locking functions of NSPR.
  40. **
  41. **
  42. ** NSPR provides basic locking mechanisms for thread synchronization.  Locks 
  43. ** are lightweight resource contention controls that prevent multiple threads 
  44. ** from accessing something (code/data) simultaneously.
  45. **/
  46. #ifndef prlock_h___
  47. #define prlock_h___
  48. #include "prtypes.h"
  49. PR_BEGIN_EXTERN_C
  50. /**********************************************************************/
  51. /************************* TYPES AND CONSTANTS ************************/
  52. /**********************************************************************/
  53. /*
  54.  * PRLock --
  55.  *
  56.  *     NSPR represents the lock as an opaque entity to the client of the
  57.  *    API.  All routines operate on a pointer to this opaque entity.
  58.  */
  59. typedef struct PRLock PRLock;
  60. /**********************************************************************/
  61. /****************************** FUNCTIONS *****************************/
  62. /**********************************************************************/
  63. /***********************************************************************
  64. ** FUNCTION:    PR_NewLock
  65. ** DESCRIPTION:
  66. **  Returns a pointer to a newly created opaque lock object.
  67. ** INPUTS:      void
  68. ** OUTPUTS:     void
  69. ** RETURN:      PRLock*
  70. **   If the lock can not be created because of resource constraints, NULL
  71. **   is returned.
  72. **  
  73. ***********************************************************************/
  74. NSPR_API(PRLock*) PR_NewLock(void);
  75. /***********************************************************************
  76. ** FUNCTION:    PR_DestroyLock
  77. ** DESCRIPTION:
  78. **  Destroys a given opaque lock object.
  79. ** INPUTS:      PRLock *lock
  80. **              Lock to be freed.
  81. ** OUTPUTS:     void
  82. ** RETURN:      None
  83. ***********************************************************************/
  84. NSPR_API(void) PR_DestroyLock(PRLock *lock);
  85. /***********************************************************************
  86. ** FUNCTION:    PR_Lock
  87. ** DESCRIPTION:
  88. **  Lock a lock.
  89. ** INPUTS:      PRLock *lock
  90. **              Lock to locked.
  91. ** OUTPUTS:     void
  92. ** RETURN:      None
  93. ***********************************************************************/
  94. NSPR_API(void) PR_Lock(PRLock *lock);
  95. /***********************************************************************
  96. ** FUNCTION:    PR_Unlock
  97. ** DESCRIPTION:
  98. **  Unlock a lock.  Unlocking an unlocked lock has undefined results.
  99. ** INPUTS:      PRLock *lock
  100. **              Lock to unlocked.
  101. ** OUTPUTS:     void
  102. ** RETURN:      PR_STATUS
  103. **              Returns PR_FAILURE if the caller does not own the lock.
  104. ***********************************************************************/
  105. NSPR_API(PRStatus) PR_Unlock(PRLock *lock);
  106. PR_END_EXTERN_C
  107. #endif /* prlock_h___ */