Back to index

lightning-sunbird  0.9+nobinonly
rcmon.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 ** Class: RCMonitor (ref prmonitor.h)
00040 **
00041 ** RCMonitor.h - C++ wrapper around NSPR's monitors
00042 */
00043 #if defined(_RCMONITOR_H)
00044 #else
00045 #define _RCMONITOR_H
00046 
00047 #include "rcbase.h"
00048 #include "rcinrval.h"
00049 
00050 struct PRMonitor;
00051 
00052 class PR_IMPLEMENT(RCMonitor): public RCBase
00053 {
00054 public:
00055     RCMonitor();                    /* timeout is infinity */
00056     virtual ~RCMonitor();
00057 
00058     virtual void Enter();           /* reentrant entry */
00059     virtual void Exit();
00060 
00061     virtual void Notify();          /* possibly enable one thread */
00062     virtual void NotifyAll();       /* enable all waiters */
00063 
00064     virtual void Wait();            /* applies object's timeout */
00065 
00066     virtual void SetTimeout(const RCInterval& timeout);
00067 
00068 private:
00069     PRMonitor *monitor;
00070     RCInterval timeout;
00071 
00072 public:
00073     RCInterval GetTimeout() const;  /* get the current value */
00074 
00075 };  /* RCMonitor */
00076 
00077 #endif /* defined(_RCMONITOR_H) */
00078 
00079 /* RCMonitor.h */