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