← Back to branch summary

~ubuntu-branches/ubuntu/precise/kompozer/precise

« back to all changes in this revision

Viewing changes to mozilla/ipc/ipcd/extensions/lock/public/ipcILockService.idl

  • Committer: Bazaar Package Importer
  • Author(s): Anthony Yarusso
  • Date: 2007-08-27 01:11:03 UTC
  • Revision ID: james.westby@ubuntu.com-20070827011103-2jgf4s6532gqu2ka
Tags: upstream-0.7.10
Import upstream version 0.7.10

Show diffs side-by-side

added added

removed removed

Lines of Context:
mozilla/ipc/ipcd/extensions/lock/public/ipcILockService.idl
 
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 <darin@netscape.com>
 
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
interface ipcILockNotify;
 
41
 
 
42
/**
 
43
 * This service provides named interprocess locking with either synchronous
 
44
 * or asynchronous waiting.
 
45
 */
 
46
[scriptable, uuid(9f6dbe15-d851-4b00-912a-5ac0be88a409)]
 
47
interface ipcILockService : nsISupports
 
48
{
 
49
    /**
 
50
     * Call this method to acquire a named lock.  Pass a notification handler
 
51
     * to be notified asynchronously when the lock is acquired.  Otherwise,
 
52
     * this function will block until the lock is acquired.
 
53
     *
 
54
     * @param aLockName
 
55
     *        specifies the name of the lock
 
56
     * @param aNotify
 
57
     *        notification callback (NULL to synchronously acquire lock)
 
58
     * @param aWaitIfBusy
 
59
     *        wait for the lock to become available; otherwise, fail if lock
 
60
     *        is already held by some other process.
 
61
     */
 
62
    void acquireLock(in string aLockName,
 
63
                     in ipcILockNotify aNotify,
 
64
                     in boolean aWaitIfBusy);
 
65
 
 
66
    /**
 
67
     * Call this method to release a named lock.  This method can be called
 
68
     * before OnAcquireLockComplete has been called, which will effectively
 
69
     * cancel the request to acquire the named lock.  OnAcquireLockComplete
 
70
     * will not be called after a call to ReleaseLock.
 
71
     *
 
72
     * @param aLockName
 
73
     *        specifies the name of the lock
 
74
     */
 
75
    void releaseLock(in string aLockName);
 
76
};
 
77
 
 
78
%{C++
 
79
// singleton implementing ipcILockService
 
80
#define IPC_LOCKSERVICE_CLASSNAME \
 
81
    "ipcLockService"
 
82
#define IPC_LOCKSERVICE_CONTRACTID \
 
83
    "@mozilla.org/ipc/lock-service;1"
 
84
#define IPC_LOCKSERVICE_CID                          \
 
85
{ /* d9e56bf8-e32e-4b6d-87f1-06d73b0ce7ca */         \
 
86
    0xd9e56bf8,                                      \
 
87
    0xe32e,                                          \
 
88
    0x4b6d,                                          \
 
89
    {0x87, 0xf1, 0x06, 0xd7, 0x3b, 0x0c, 0xe7, 0xca} \
 
90
}
 
91
%}