| 1 | /* ***** BEGIN LICENSE BLOCK *****
|
|---|
| 2 | * Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|---|
| 3 | *
|
|---|
| 4 | * The contents of this file are subject to the Mozilla Public License Version
|
|---|
| 5 | * 1.1 (the "License"); you may not use this file except in compliance with
|
|---|
| 6 | * the License. You may obtain a copy of the License at
|
|---|
| 7 | * http://www.mozilla.org/MPL/
|
|---|
| 8 | *
|
|---|
| 9 | * Software distributed under the License is distributed on an "AS IS" basis,
|
|---|
| 10 | * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|---|
| 11 | * for the specific language governing rights and limitations under the
|
|---|
| 12 | * License.
|
|---|
| 13 | *
|
|---|
| 14 | * The Original Code is Mozilla IPC.
|
|---|
| 15 | *
|
|---|
| 16 | * The Initial Developer of the Original Code is
|
|---|
| 17 | * Netscape Communications Corporation.
|
|---|
| 18 | * Portions created by the Initial Developer are Copyright (C) 2002
|
|---|
| 19 | * the Initial Developer. All Rights Reserved.
|
|---|
| 20 | *
|
|---|
| 21 | * Contributor(s):
|
|---|
| 22 | * Darin Fisher <[email protected]>
|
|---|
| 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 | #include "nsISupports.idl"
|
|---|
| 39 |
|
|---|
| 40 | /**
|
|---|
| 41 | * This service provides named interprocess locking.
|
|---|
| 42 | */
|
|---|
| 43 | [scriptable, uuid(9f6dbe15-d851-4b00-912a-5ac0be88a409)]
|
|---|
| 44 | interface ipcILockService : nsISupports
|
|---|
| 45 | {
|
|---|
| 46 | /**
|
|---|
| 47 | * Call this method to acquire a named interprocess lock.
|
|---|
| 48 | *
|
|---|
| 49 | * @param aLockName
|
|---|
| 50 | * specifies the name of the lock
|
|---|
| 51 | * @param aWaitIfBusy
|
|---|
| 52 | * wait for the lock to become available; otherwise, fail if lock
|
|---|
| 53 | * is already held by some other process.
|
|---|
| 54 | */
|
|---|
| 55 | void acquireLock(in string aLockName,
|
|---|
| 56 | in boolean aWaitIfBusy);
|
|---|
| 57 |
|
|---|
| 58 | /**
|
|---|
| 59 | * Call this method to release a named lock.
|
|---|
| 60 | *
|
|---|
| 61 | * @param aLockName
|
|---|
| 62 | * specifies the name of the lock
|
|---|
| 63 | */
|
|---|
| 64 | void releaseLock(in string aLockName);
|
|---|
| 65 | };
|
|---|
