PageRenderTime 49ms CodeModel.GetById 43ms app.highlight 3ms RepoModel.GetById 1ms app.codeStats 0ms

/gecko_api/include/prlock.h

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