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 /* 36 * File: prpdce.h 37 * Description: This file is the API defined to allow for DCE (aka POSIX) 38 * thread emulation in an NSPR environment. It is not the 39 * intent that this be a fully supported API. 40 */ 41 42 #if !defined(PRPDCE_H) 43 #define PRPDCE_H 44 45 #include "prlock.h" 46 #include "prcvar.h" 47 #include "prtypes.h" 48 #include "prinrval.h" 49 50 PR_BEGIN_EXTERN_C 51 52 #define _PR_NAKED_CV_LOCK (PRLock*)0xdce1dce1 53 54 /* 55 ** Test and acquire a lock. 56 ** 57 ** If the lock is acquired by the calling thread, the 58 ** return value will be PR_SUCCESS. If the lock is 59 ** already held, by another thread or this thread, the 60 ** result will be PR_FAILURE. 61 */ 62 NSPR_API(PRStatus) PRP_TryLock(PRLock *lock); 63 64 /* 65 ** Create a naked condition variable 66 ** 67 ** A "naked" condition variable is one that is not created bound 68 ** to a lock. The CV created with this function is the only type 69 ** that may be used in the subsequent "naked" condition variable 70 ** operations (see PRP_NakedWait, PRP_NakedNotify, PRP_NakedBroadcast); 71 */ 72 NSPR_API(PRCondVar*) PRP_NewNakedCondVar(void); 73 74 /* 75 ** Destroy a naked condition variable 76 ** 77 ** Destroy the condition variable created by PR_NewNakedCondVar. 78 */ 79 NSPR_API(void) PRP_DestroyNakedCondVar(PRCondVar *cvar); 80 81 /* 82 ** Wait on a condition 83 ** 84 ** Wait on the condition variable 'cvar'. It is asserted that 85 ** the lock protecting the condition 'lock' is held by the 86 ** calling thread. If more time expires than that declared in 87 ** 'timeout' the condition will be notified. Waits can be 88 ** interrupted by another thread. 89 ** 90 ** NB: The CV ('cvar') must be one created using PR_NewNakedCondVar. 91 */ 92 NSPR_API(PRStatus) PRP_NakedWait( 93 PRCondVar *cvar, PRLock *lock, PRIntervalTime timeout); 94 95 /* 96 ** Notify a thread waiting on a condition 97 ** 98 ** Notify the condition specified 'cvar'. 99 ** 100 ** NB: The CV ('cvar') must be one created using PR_NewNakedCondVar. 101 */ 102 NSPR_API(PRStatus) PRP_NakedNotify(PRCondVar *cvar); 103 104 /* 105 ** Notify all threads waiting on a condition 106 ** 107 ** Notify the condition specified 'cvar'. 108 ** 109 ** NB: The CV ('cvar') must be one created using PR_NewNakedCondVar. 110 */ 111 NSPR_API(PRStatus) PRP_NakedBroadcast(PRCondVar *cvar); 112 113 PR_END_EXTERN_C 114 115 #endif /* PRPDCE_H */ 116