PageRenderTime 82ms CodeModel.GetById 40ms app.highlight 3ms RepoModel.GetById 37ms app.codeStats 0ms

/gecko_api/include/prmon.h

http://firefox-mac-pdf.googlecode.com/
C++ Header | 113 lines | 15 code | 13 blank | 85 comment | 0 complexity | 3ee2783107fddba70e509cfacb85af35 MD5 | raw file
  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#ifndef prmon_h___
 39#define prmon_h___
 40
 41#include "prtypes.h"
 42#include "prinrval.h"
 43
 44PR_BEGIN_EXTERN_C
 45
 46typedef struct PRMonitor PRMonitor;
 47
 48/*
 49** Create a new monitor. Monitors are re-entrant locks with a single built-in
 50** condition variable.
 51**
 52** This may fail if memory is tight or if some operating system resource
 53** is low.
 54*/
 55NSPR_API(PRMonitor*) PR_NewMonitor(void);
 56
 57/*
 58** Destroy a monitor. The caller is responsible for guaranteeing that the
 59** monitor is no longer in use. There must be no thread waiting on the monitor's
 60** condition variable and that the lock is not held.
 61**
 62*/
 63NSPR_API(void) PR_DestroyMonitor(PRMonitor *mon);
 64
 65/*
 66** Enter the lock associated with the monitor. If the calling thread currently
 67** is in the monitor, the call to enter will silently succeed. In either case,
 68** it will increment the entry count by one.
 69*/
 70NSPR_API(void) PR_EnterMonitor(PRMonitor *mon);
 71
 72/*
 73** Decrement the entry count associated with the monitor. If the decremented
 74** entry count is zero, the monitor is exited. Returns PR_FAILURE if the
 75** calling thread has not entered the monitor.
 76*/
 77NSPR_API(PRStatus) PR_ExitMonitor(PRMonitor *mon);
 78
 79/*
 80** Wait for a notify on the monitor's condition variable. Sleep for "ticks"
 81** amount of time (if "ticks" is PR_INTERVAL_NO_TIMEOUT then the sleep is
 82** indefinite).
 83**
 84** While the thread is waiting it exits the monitor (as if it called
 85** PR_ExitMonitor as many times as it had called PR_EnterMonitor).  When
 86** the wait has finished the thread regains control of the monitors lock
 87** with the same entry count as before the wait began.
 88**
 89** The thread waiting on the monitor will be resumed when the monitor is
 90** notified (assuming the thread is the next in line to receive the
 91** notify) or when the "ticks" timeout elapses.
 92**
 93** Returns PR_FAILURE if the caller has not entered the monitor.
 94*/
 95NSPR_API(PRStatus) PR_Wait(PRMonitor *mon, PRIntervalTime ticks);
 96
 97/*
 98** Notify a thread waiting on the monitor's condition variable. If a thread
 99** is waiting on the condition variable (using PR_Wait) then it is awakened
100** and attempts to reenter the monitor.
101*/
102NSPR_API(PRStatus) PR_Notify(PRMonitor *mon);
103
104/*
105** Notify all of the threads waiting on the monitor's condition variable.
106** All of threads waiting on the condition are scheduled to reenter the
107** monitor.
108*/
109NSPR_API(PRStatus) PR_NotifyAll(PRMonitor *mon);
110
111PR_END_EXTERN_C
112
113#endif /* prmon_h___ */