/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is Mozilla IPC.
 *
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 2002
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Darin Fisher <darin@netscape.com>
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "nsISupports.idl"

interface ipcILockNotify;

/**
 * This service provides named interprocess locking with either synchronous
 * or asynchronous waiting.
 */
[scriptable, uuid(9f6dbe15-d851-4b00-912a-5ac0be88a409)]
interface ipcILockService : nsISupports
{
    /**
     * Call this method to acquire a named lock.  Pass a notification handler
     * to be notified asynchronously when the lock is acquired.  Otherwise,
     * this function will block until the lock is acquired.
     *
     * @param aLockName
     *        specifies the name of the lock
     * @param aNotify
     *        notification callback (NULL to synchronously acquire lock)
     * @param aWaitIfBusy
     *        wait for the lock to become available; otherwise, fail if lock
     *        is already held by some other process.
     */
    void acquireLock(in string aLockName,
                     in ipcILockNotify aNotify,
                     in boolean aWaitIfBusy);

    /**
     * Call this method to release a named lock.  This method can be called
     * before OnAcquireLockComplete has been called, which will effectively
     * cancel the request to acquire the named lock.  OnAcquireLockComplete
     * will not be called after a call to ReleaseLock.
     *
     * @param aLockName
     *        specifies the name of the lock
     */
    void releaseLock(in string aLockName);
};

%{C++
// singleton implementing ipcILockService
#define IPC_LOCKSERVICE_CLASSNAME \
    "ipcLockService"
#define IPC_LOCKSERVICE_CONTRACTID \
    "@mozilla.org/ipc/lock-service;1"
#define IPC_LOCKSERVICE_CID                          \
{ /* d9e56bf8-e32e-4b6d-87f1-06d73b0ce7ca */         \
    0xd9e56bf8,                                      \
    0xe32e,                                          \
    0x4b6d,                                          \
    {0x87, 0xf1, 0x06, 0xd7, 0x3b, 0x0c, 0xe7, 0xca} \
}
%}