← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/virtualbox-ose/gutsy

« back to all changes in this revision

Viewing changes to src/libs/xpcom18a4/ipc/ipcd/extensions/transmngr/public/ipcITransactionObserver.idl

  • Committer: Bazaar Package Importer
  • Author(s): Steve Kowalik
  • Date: 2007-09-08 16:44:58 UTC
  • Revision ID: james.westby@ubuntu.com-20070908164458-wao29470vqtr8ksy
Tags: upstream-1.5.0-dfsg2
Import upstream version 1.5.0-dfsg2

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/libs/xpcom18a4/ipc/ipcd/extensions/transmngr/public/ipcITransactionObserver.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 Transaction Manager.
 
15
 *
 
16
 * The Initial Developer of the Original Code is
 
17
 * Netscape Communications Corp.
 
18
 * Portions created by the Initial Developer are Copyright (C) 2003
 
19
 * the Initial Developer. All Rights Reserved.
 
20
 *
 
21
 * Contributor(s):
 
22
 *   John Gaunt <jgaunt@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
[scriptable, uuid(656c0a6a-5cb3-45ec-8cb6-e7678897f937)]
 
41
interface ipcITransactionObserver : nsISupports
 
42
{
 
43
  /**
 
44
    * This gets called when a Transaction has been sent from the 
 
45
    *   TransactionManager. If the data passed in needs to be stored
 
46
    *   for longer than the life of the method the observer needs
 
47
    *   to make a copy.
 
48
    *
 
49
    * @param aQueueID
 
50
    *        The queue from which the transaction originated
 
51
    *
 
52
    * @param aData
 
53
    *        The data to be sent.
 
54
    *
 
55
    * @param aDataLen
 
56
    *        The length of the data argument
 
57
    */
 
58
  void onTransactionAvailable(in unsigned long aQueueID,
 
59
                              [array, const, size_is(aDataLen)]
 
60
                              in octet aData,
 
61
                              in unsigned long aDataLen);
 
62
 
 
63
  /**
 
64
    * Called after an application sends an Attach message to the
 
65
    *   Transaction Manager.
 
66
    *
 
67
    * @param aQueueID
 
68
    *        The client has been attached to the queue with this ID
 
69
    *
 
70
    * @param aStatus
 
71
    *        The status of the operation, as defined in tmUtils.h
 
72
    */
 
73
  void onAttachReply(in unsigned long aQueueID, in unsigned long aStatus);
 
74
 
 
75
  /**
 
76
    * Called after an application sends a Detach message. Indicates 
 
77
    *   to the client that no more messages will be coming from the
 
78
    *   the TM to this client. Also, no messages posted from this
 
79
    *   client to the indicated queue will be accepted.
 
80
    *
 
81
    * @param aQueueID
 
82
    *        The client has been detached from the queue with this ID
 
83
    *
 
84
    * @param aStatus
 
85
    *        The status of the operation, as defined in tmUtils.h
 
86
    */
 
87
  void onDetachReply(in unsigned long aQueueID, in unsigned long aStatus);
 
88
 
 
89
  /**
 
90
    * The reply from the TM indicating all messages have been removed
 
91
    *   from the queue indicated.
 
92
    *
 
93
    * @param aQueueID
 
94
    *        The queue that has been flushed.
 
95
    *
 
96
    * @param aStatus
 
97
    *        The status of the operation, as defined in tmUtils.h
 
98
    */
 
99
  void onFlushReply(in unsigned long aQueueID, in unsigned long aStatus);
 
100
};