Back to index

lightning-sunbird  0.9+nobinonly
rccv.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 ** RCCondition - C++ wrapper around NSPR's PRCondVar
00040 **
00041 ** Conditions have a notion of timeouts. A thread that waits on a condition
00042 ** will resume execution when the condition is notified OR when a specified
00043 ** interval of time has expired.
00044 **
00045 ** Most applications don't adjust the timeouts on conditions. The literature
00046 ** would argue that all threads waiting on a single condition must have the
00047 ** same semantics. But if an application wishes to modify the timeout with
00048 ** (perhaps) each wait call, that modification should be done consistantly
00049 ** and under protection of the condition's associated lock.
00050 **
00051 ** The default timeout is infinity.
00052 */
00053 
00054 #if defined(_RCCOND_H)
00055 #else
00056 #define _RCCOND_H
00057 
00058 #include "rclock.h"
00059 #include "rcbase.h"
00060 #include "rcinrval.h"
00061 
00062 struct PRCondVar;
00063 
00064 class PR_IMPLEMENT(RCCondition): public RCBase
00065 {
00066 public:
00067     RCCondition(RCLock*);           /* associates CV with a lock and infinite tmo */
00068     virtual ~RCCondition();
00069 
00070     virtual PRStatus Wait();        /* applies object's current timeout */
00071 
00072     virtual PRStatus Notify();      /* perhaps ready one thread */
00073     virtual PRStatus Broadcast();   /* perhaps ready many threads */
00074 
00075     virtual PRStatus SetTimeout(const RCInterval&);
00076                                     /* set object's current timeout value */
00077 
00078 private:
00079     PRCondVar *cv;
00080     RCInterval timeout;
00081 
00082     RCCondition();
00083     RCCondition(const RCCondition&);
00084     void operator=(const RCCondition&);
00085 
00086 public:
00087     RCInterval GetTimeout() const;
00088 };  /* RCCondition */
00089 
00090 inline RCCondition::RCCondition(): RCBase() { }
00091 inline RCCondition::RCCondition(const RCCondition&): RCBase() { }
00092 inline void RCCondition::operator=(const RCCondition&) { }
00093 
00094 #endif /* defined(_RCCOND_H) */
00095 
00096 /* RCCond.h */