/gecko_api/include/prcmon.h
C++ Header | 98 lines | 13 code | 11 blank | 74 comment | 0 complexity | e3f8c44e9ba6aa369187b88ba30d03bb 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#ifndef prcmon_h___ 39#define prcmon_h___ 40 41/* 42** Interface to cached monitors. Cached monitors use an address to find a 43** given PR monitor. In this way a monitor can be associated with another 44** object without preallocating a monitor for all objects. 45** 46** A hash table is used to quickly map addresses to individual monitors 47** and the system automatically grows the hash table as needed. 48** 49** Cache monitors are about 5 times slower to use than uncached monitors. 50*/ 51#include "prmon.h" 52#include "prinrval.h" 53 54PR_BEGIN_EXTERN_C 55 56/** 57** Like PR_EnterMonitor except use the "address" to find a monitor in the 58** monitor cache. If successful, returns the PRMonitor now associated 59** with "address". Note that you must PR_CExitMonitor the address to 60** release the monitor cache entry (otherwise the monitor cache will fill 61** up). This call will return NULL if the monitor cache needs to be 62** expanded and the system is out of memory. 63*/ 64NSPR_API(PRMonitor*) PR_CEnterMonitor(void *address); 65 66/* 67** Like PR_ExitMonitor except use the "address" to find a monitor in the 68** monitor cache. 69*/ 70NSPR_API(PRStatus) PR_CExitMonitor(void *address); 71 72/* 73** Like PR_Wait except use the "address" to find a monitor in the 74** monitor cache. 75*/ 76NSPR_API(PRStatus) PR_CWait(void *address, PRIntervalTime timeout); 77 78/* 79** Like PR_Notify except use the "address" to find a monitor in the 80** monitor cache. 81*/ 82NSPR_API(PRStatus) PR_CNotify(void *address); 83 84/* 85** Like PR_NotifyAll except use the "address" to find a monitor in the 86** monitor cache. 87*/ 88NSPR_API(PRStatus) PR_CNotifyAll(void *address); 89 90/* 91** Set a callback to be invoked each time a monitor is recycled from the cache 92** freelist, with the monitor's cache-key passed in address. 93*/ 94NSPR_API(void) PR_CSetOnMonitorRecycle(void (PR_CALLBACK *callback)(void *address)); 95 96PR_END_EXTERN_C 97 98#endif /* prcmon_h___ */