MTransactionOwner Class Reference

class MTransactionOwner

This class defines the events which the Transaction subsystem will send to upper layers. Any subsystem which is using Transaction subsystem, has to implement this class.

Constructor & Destructor Documentation

~MTransactionOwner()

~MTransactionOwner()[inline, virtual]

Member Functions Documentation

NextCSeq(TUint &)

TInt NextCSeq(TUint &aCSeq)[pure virtual]

TransactionUser is going to send the SIP request either after modifications to the request, or to another address, and asks the next CSeq sequence number to use for the request.

Pre-condition
Post-condition

Parameters

TUint & aCSeqan in-out parameter. While entering the function contains the current CSeq of the caller. On return contains the incremented CSeq of the callee. If the subsystem implementing the interface does not keep track of the CSeqs it should simply increment aCSeq by one.

ReceiveL(TUint32, TTransactionId, CSIPRequest *)

voidReceiveL(TUint32aIapId,
TTransactionIdaTransactionId,
CSIPRequest *aRequest
)[pure virtual]

Transaction has received a SIP request from a remote endpoint and passes it to the upper layer.

Pre-condition
aRequest != 0

Parameters

TUint32 aIapIdThe IAP using which the request was received.
TTransactionId aTransactionIdIdentifies the transaction
CSIPRequest * aRequestIN: SIP request message. The ownership is transferred. If the function leaves, the ownership of aRequest is NOT transferred.

ReceiveL(TTransactionId, CSIPResponse *)

voidReceiveL(TTransactionIdaTransactionId,
CSIPResponse *aResponse
)[pure virtual]

Transaction has received a SIP response message from remote endpoint and passes it to the upper layer.

Pre-condition
aResponse != 0

Parameters

TTransactionId aTransactionIdIdentifies the transaction
CSIPResponse * aResponseIN: SIP response message. The ownership is transferred. If the function leaves, the ownership of aResponse is NOT transferred.

SIPSecUser()

const MSIPSecUser *SIPSecUser()const [pure virtual]

Returns a pointer to the MSIPSecUser that is used to map the SIPSec cache entries to their users and can be used to query credentials from the user.

TransactionEnded(TUint32, TTransactionId, TInt)

TInt TransactionEnded(TUint32aIapId,
TTransactionIdaTransaction,
TIntaReason
)[pure virtual]

The specified transaction has ended and no more events from that transaction will come through the MTransactionOwner interface.

Pre-condition
Post-condition

Parameters

TUint32 aIapIdThe IAP used.
TTransactionId aTransactionIdentifies the transaction that ended
TInt aReasonTells why the transaction ended. KErrNone means the transaction ended normally.