Back to index

lightning-sunbird  0.9+nobinonly
prpdce.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 /*
00039  * File:             prpdce.h
00040  * Description:      This file is the API defined to allow for DCE (aka POSIX)
00041  *                          thread emulation in an NSPR environment. It is not the
00042  *                          intent that this be a fully supported API.
00043  */
00044 
00045 #if !defined(PRPDCE_H)
00046 #define PRPDCE_H
00047 
00048 #include "prlock.h"
00049 #include "prcvar.h"
00050 #include "prtypes.h"
00051 #include "prinrval.h"
00052 
00053 PR_BEGIN_EXTERN_C
00054 
00055 #define _PR_NAKED_CV_LOCK (PRLock*)0xdce1dce1
00056 
00057 /*
00058 ** Test and acquire a lock.
00059 **
00060 ** If the lock is acquired by the calling thread, the
00061 ** return value will be PR_SUCCESS. If the lock is
00062 ** already held, by another thread or this thread, the
00063 ** result will be PR_FAILURE.
00064 */
00065 NSPR_API(PRStatus) PRP_TryLock(PRLock *lock);
00066 
00067 /*
00068 ** Create a naked condition variable
00069 **
00070 ** A "naked" condition variable is one that is not created bound
00071 ** to a lock. The CV created with this function is the only type
00072 ** that may be used in the subsequent "naked" condition variable
00073 ** operations (see PRP_NakedWait, PRP_NakedNotify, PRP_NakedBroadcast);
00074 */
00075 NSPR_API(PRCondVar*) PRP_NewNakedCondVar(void);
00076 
00077 /*
00078 ** Destroy a naked condition variable
00079 **
00080 ** Destroy the condition variable created by PR_NewNakedCondVar.
00081 */
00082 NSPR_API(void) PRP_DestroyNakedCondVar(PRCondVar *cvar);
00083 
00084 /*
00085 ** Wait on a condition
00086 **
00087 ** Wait on the condition variable 'cvar'. It is asserted that
00088 ** the lock protecting the condition 'lock' is held by the
00089 ** calling thread. If more time expires than that declared in
00090 ** 'timeout' the condition will be notified. Waits can be
00091 ** interrupted by another thread.
00092 **
00093 ** NB: The CV ('cvar') must be one created using PR_NewNakedCondVar.
00094 */
00095 NSPR_API(PRStatus) PRP_NakedWait(
00096        PRCondVar *cvar, PRLock *lock, PRIntervalTime timeout);
00097 
00098 /*
00099 ** Notify a thread waiting on a condition
00100 **
00101 ** Notify the condition specified 'cvar'.
00102 **
00103 ** NB: The CV ('cvar') must be one created using PR_NewNakedCondVar.
00104 */
00105 NSPR_API(PRStatus) PRP_NakedNotify(PRCondVar *cvar);
00106 
00107 /*
00108 ** Notify all threads waiting on a condition
00109 **
00110 ** Notify the condition specified 'cvar'.
00111 **
00112 ** NB: The CV ('cvar') must be one created using PR_NewNakedCondVar.
00113 */
00114 NSPR_API(PRStatus) PRP_NakedBroadcast(PRCondVar *cvar);
00115 
00116 PR_END_EXTERN_C
00117 
00118 #endif /* PRPDCE_H */