1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2/*
3 * The contents of this file are subject to the Mozilla Public
4 * License Version 1.1 (the "License"); you may not use this file
5 * except in compliance with the License. You may obtain a copy of
6 * the License at http://www.mozilla.org/MPL/
7 *
8 * Software distributed under the License is distributed on an "AS
9 * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
10 * implied. See the License for the specific language governing
11 * rights and limitations under the License.
12 *
13 * The Original Code is the Netscape Portable Runtime (NSPR).
14 *
15 * The Initial Developer of the Original Code is Netscape
16 * Communications Corporation.  Portions created by Netscape are
17 * Copyright (C) 1998-2000 Netscape Communications Corporation.  All
18 * Rights Reserved.
19 *
20 * Contributor(s):
21 *
22 * Alternatively, the contents of this file may be used under the
23 * terms of the GNU General Public License Version 2 or later (the
24 * "GPL"), in which case the provisions of the GPL are applicable
25 * instead of those above.  If you wish to allow use of your
26 * version of this file only under the terms of the GPL and not to
27 * allow others to use your version of this file under the MPL,
28 * indicate your decision by deleting the provisions above and
29 * replace them with the notice and other provisions required by
30 * the GPL.  If you do not delete the provisions above, a recipient
31 * may use your version of this file under either the MPL or the
32 * GPL.
33 */
34
35#ifndef prcmon_h___
36#define prcmon_h___
37
38/*
39** Interface to cached monitors. Cached monitors use an address to find a
40** given PR monitor. In this way a monitor can be associated with another
41** object without preallocating a monitor for all objects.
42**
43** A hash table is used to quickly map addresses to individual monitors
44** and the system automatically grows the hash table as needed.
45**
46** Cache monitors are about 5 times slower to use than uncached monitors.
47*/
48#include "prmon.h"
49#include "prinrval.h"
50
51PR_BEGIN_EXTERN_C
52
53/**
54** Like PR_EnterMonitor except use the "address" to find a monitor in the
55** monitor cache. If successful, returns the PRMonitor now associated
56** with "address". Note that you must PR_CExitMonitor the address to
57** release the monitor cache entry (otherwise the monitor cache will fill
58** up). This call will return NULL if the monitor cache needs to be
59** expanded and the system is out of memory.
60*/
61NSPR_API(PRMonitor*) PR_CEnterMonitor(void *address);
62
63/*
64** Like PR_ExitMonitor except use the "address" to find a monitor in the
65** monitor cache.
66*/
67NSPR_API(PRStatus) PR_CExitMonitor(void *address);
68
69/*
70** Like PR_Wait except use the "address" to find a monitor in the
71** monitor cache.
72*/
73NSPR_API(PRStatus) PR_CWait(void *address, PRIntervalTime timeout);
74
75/*
76** Like PR_Notify except use the "address" to find a monitor in the
77** monitor cache.
78*/
79NSPR_API(PRStatus) PR_CNotify(void *address);
80
81/*
82** Like PR_NotifyAll except use the "address" to find a monitor in the
83** monitor cache.
84*/
85NSPR_API(PRStatus) PR_CNotifyAll(void *address);
86
87/*
88** Set a callback to be invoked each time a monitor is recycled from the cache
89** freelist, with the monitor's cache-key passed in address.
90*/
91NSPR_API(void) PR_CSetOnMonitorRecycle(void (PR_CALLBACK *callback)(void *address));
92
93PR_END_EXTERN_C
94
95#endif /* prcmon_h___ */
96