nsprpub/pr/include/prrwlock.h@6474c204b198 (annotated)
nsprpub/pr/include/prrwlock.h
Wed, 31 Dec 2014 06:09:35 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:09:35 +0100
- changeset 0
- 6474c204b198
- permissions
- -rw-r--r--
Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.
| michael@0 | 1 | /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ |
| michael@0 | 2 | /* This Source Code Form is subject to the terms of the Mozilla Public |
| michael@0 | 3 | * License, v. 2.0. If a copy of the MPL was not distributed with this |
| michael@0 | 4 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
| michael@0 | 5 | |
| michael@0 | 6 | /* |
| michael@0 | 7 | ** File: prrwlock.h |
| michael@0 | 8 | ** Description: API to basic reader-writer lock functions of NSPR. |
| michael@0 | 9 | ** |
| michael@0 | 10 | **/ |
| michael@0 | 11 | |
| michael@0 | 12 | #ifndef prrwlock_h___ |
| michael@0 | 13 | #define prrwlock_h___ |
| michael@0 | 14 | |
| michael@0 | 15 | #include "prtypes.h" |
| michael@0 | 16 | |
| michael@0 | 17 | PR_BEGIN_EXTERN_C |
| michael@0 | 18 | |
| michael@0 | 19 | /* |
| michael@0 | 20 | * PRRWLock -- |
| michael@0 | 21 | * |
| michael@0 | 22 | * The reader writer lock, PRRWLock, is an opaque object to the clients |
| michael@0 | 23 | * of NSPR. All routines operate on a pointer to this opaque entity. |
| michael@0 | 24 | */ |
| michael@0 | 25 | |
| michael@0 | 26 | |
| michael@0 | 27 | typedef struct PRRWLock PRRWLock; |
| michael@0 | 28 | |
| michael@0 | 29 | #define PR_RWLOCK_RANK_NONE 0 |
| michael@0 | 30 | |
| michael@0 | 31 | |
| michael@0 | 32 | /*********************************************************************** |
| michael@0 | 33 | ** FUNCTION: PR_NewRWLock |
| michael@0 | 34 | ** DESCRIPTION: |
| michael@0 | 35 | ** Returns a pointer to a newly created reader-writer lock object. |
| michael@0 | 36 | ** INPUTS: Lock rank |
| michael@0 | 37 | ** Lock name |
| michael@0 | 38 | ** OUTPUTS: void |
| michael@0 | 39 | ** RETURN: PRRWLock* |
| michael@0 | 40 | ** If the lock cannot be created because of resource constraints, NULL |
| michael@0 | 41 | ** is returned. |
| michael@0 | 42 | ** |
| michael@0 | 43 | ***********************************************************************/ |
| michael@0 | 44 | NSPR_API(PRRWLock*) PR_NewRWLock(PRUint32 lock_rank, const char *lock_name); |
| michael@0 | 45 | |
| michael@0 | 46 | /*********************************************************************** |
| michael@0 | 47 | ** FUNCTION: PR_DestroyRWLock |
| michael@0 | 48 | ** DESCRIPTION: |
| michael@0 | 49 | ** Destroys a given RW lock object. |
| michael@0 | 50 | ** INPUTS: PRRWLock *lock - Lock to be freed. |
| michael@0 | 51 | ** OUTPUTS: void |
| michael@0 | 52 | ** RETURN: None |
| michael@0 | 53 | ***********************************************************************/ |
| michael@0 | 54 | NSPR_API(void) PR_DestroyRWLock(PRRWLock *lock); |
| michael@0 | 55 | |
| michael@0 | 56 | /*********************************************************************** |
| michael@0 | 57 | ** FUNCTION: PR_RWLock_Rlock |
| michael@0 | 58 | ** DESCRIPTION: |
| michael@0 | 59 | ** Apply a read lock (non-exclusive) on a RWLock |
| michael@0 | 60 | ** INPUTS: PRRWLock *lock - Lock to be read-locked. |
| michael@0 | 61 | ** OUTPUTS: void |
| michael@0 | 62 | ** RETURN: None |
| michael@0 | 63 | ***********************************************************************/ |
| michael@0 | 64 | NSPR_API(void) PR_RWLock_Rlock(PRRWLock *lock); |
| michael@0 | 65 | |
| michael@0 | 66 | /*********************************************************************** |
| michael@0 | 67 | ** FUNCTION: PR_RWLock_Wlock |
| michael@0 | 68 | ** DESCRIPTION: |
| michael@0 | 69 | ** Apply a write lock (exclusive) on a RWLock |
| michael@0 | 70 | ** INPUTS: PRRWLock *lock - Lock to write-locked. |
| michael@0 | 71 | ** OUTPUTS: void |
| michael@0 | 72 | ** RETURN: None |
| michael@0 | 73 | ***********************************************************************/ |
| michael@0 | 74 | NSPR_API(void) PR_RWLock_Wlock(PRRWLock *lock); |
| michael@0 | 75 | |
| michael@0 | 76 | /*********************************************************************** |
| michael@0 | 77 | ** FUNCTION: PR_RWLock_Unlock |
| michael@0 | 78 | ** DESCRIPTION: |
| michael@0 | 79 | ** Release a RW lock. Unlocking an unlocked lock has undefined results. |
| michael@0 | 80 | ** INPUTS: PRRWLock *lock - Lock to unlocked. |
| michael@0 | 81 | ** OUTPUTS: void |
| michael@0 | 82 | ** RETURN: void |
| michael@0 | 83 | ***********************************************************************/ |
| michael@0 | 84 | NSPR_API(void) PR_RWLock_Unlock(PRRWLock *lock); |
| michael@0 | 85 | |
| michael@0 | 86 | PR_END_EXTERN_C |
| michael@0 | 87 | |
| michael@0 | 88 | #endif /* prrwlock_h___ */ |
