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