Back to index

lightning-sunbird  0.9+nobinonly
prcmon.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is the Netscape Portable Runtime (NSPR).
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998-2000
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef prcmon_h___
00039 #define prcmon_h___
00040 
00041 /*
00042 ** Interface to cached monitors. Cached monitors use an address to find a
00043 ** given PR monitor. In this way a monitor can be associated with another
00044 ** object without preallocating a monitor for all objects.
00045 **
00046 ** A hash table is used to quickly map addresses to individual monitors
00047 ** and the system automatically grows the hash table as needed.
00048 **
00049 ** Cache monitors are about 5 times slower to use than uncached monitors.
00050 */
00051 #include "prmon.h"
00052 #include "prinrval.h"
00053 
00054 PR_BEGIN_EXTERN_C
00055 
00064 NSPR_API(PRMonitor*) PR_CEnterMonitor(void *address);
00065 
00066 /*
00067 ** Like PR_ExitMonitor except use the "address" to find a monitor in the
00068 ** monitor cache.
00069 */
00070 NSPR_API(PRStatus) PR_CExitMonitor(void *address);
00071 
00072 /*
00073 ** Like PR_Wait except use the "address" to find a monitor in the
00074 ** monitor cache.
00075 */
00076 NSPR_API(PRStatus) PR_CWait(void *address, PRIntervalTime timeout);
00077 
00078 /*
00079 ** Like PR_Notify except use the "address" to find a monitor in the
00080 ** monitor cache.
00081 */
00082 NSPR_API(PRStatus) PR_CNotify(void *address);
00083 
00084 /*
00085 ** Like PR_NotifyAll except use the "address" to find a monitor in the
00086 ** monitor cache.
00087 */
00088 NSPR_API(PRStatus) PR_CNotifyAll(void *address);
00089 
00090 /*
00091 ** Set a callback to be invoked each time a monitor is recycled from the cache
00092 ** freelist, with the monitor's cache-key passed in address.
00093 */
00094 NSPR_API(void) PR_CSetOnMonitorRecycle(void (PR_CALLBACK *callback)(void *address));
00095 
00096 PR_END_EXTERN_C
00097 
00098 #endif /* prcmon_h___ */