Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
ipcITransactionObserver Interface Reference

import "ipcITransactionObserver.idl";

Inheritance diagram for ipcITransactionObserver:
Inheritance graph
[legend]
Collaboration diagram for ipcITransactionObserver:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void onTransactionAvailable (in unsigned long aQueueID,[array, const, size_is(aDataLen)] in octet aData, in unsigned long aDataLen)
 This gets called when a Transaction has been sent from the TransactionManager.
void onAttachReply (in unsigned long aQueueID, in unsigned long aStatus)
 Called after an application sends an Attach message to the Transaction Manager.
void onDetachReply (in unsigned long aQueueID, in unsigned long aStatus)
 Called after an application sends a Detach message.
void onFlushReply (in unsigned long aQueueID, in unsigned long aStatus)
 The reply from the TM indicating all messages have been removed from the queue indicated.

Detailed Description

Definition at line 41 of file ipcITransactionObserver.idl.


Member Function Documentation

void ipcITransactionObserver::onAttachReply ( in unsigned long  aQueueID,
in unsigned long  aStatus 
)

Called after an application sends an Attach message to the Transaction Manager.

Parameters:
aQueueIDThe client has been attached to the queue with this ID
aStatusThe status of the operation, as defined in tmUtils.h
void ipcITransactionObserver::onDetachReply ( in unsigned long  aQueueID,
in unsigned long  aStatus 
)

Called after an application sends a Detach message.

Indicates to the client that no more messages will be coming from the the TM to this client. Also, no messages posted from this client to the indicated queue will be accepted.

Parameters:
aQueueIDThe client has been detached from the queue with this ID
aStatusThe status of the operation, as defined in tmUtils.h
void ipcITransactionObserver::onFlushReply ( in unsigned long  aQueueID,
in unsigned long  aStatus 
)

The reply from the TM indicating all messages have been removed from the queue indicated.

Parameters:
aQueueIDThe queue that has been flushed.
aStatusThe status of the operation, as defined in tmUtils.h
void ipcITransactionObserver::onTransactionAvailable ( in unsigned long  aQueueID,
[array, const, size_is(aDataLen)] in octet  aData,
in unsigned long  aDataLen 
)

This gets called when a Transaction has been sent from the TransactionManager.

If the data passed in needs to be stored for longer than the life of the method the observer needs to make a copy.

Parameters:
aQueueIDThe queue from which the transaction originated
aDataThe data to be sent.
aDataLenThe length of the data argument

The documentation for this interface was generated from the following file: