Class CSIPTransactionBase

class CSIPTransactionBase : public CBase;

Description

Base class for managing SIP transactions. It provides services for querying transaction type and its state.

This class is an abstract class and cannot be instantiated. sipclient

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CSIPTransactionBase - Base class for managing SIP transactions

Members

Defined in CSIPTransactionBase:
ECalling, ECompleted, EConfirmed, EConstructing, EProceeding, ETerminated, ETrying, IsSIPClientTransaction(), StateL(), TState, Type(), operator==()

Inherited from CBase:
Delete(), Extension_(), operator new()

IMPORT_C RStringF Type() const;

Description

Gets the SIP transaction type

Return value

RStringF SIP transaction type

IMPORT_C CSIPTransactionBase::TState StateL();

Description

Gets SIP transaction state

Return value

CSIPTransactionBase::TState SIP transaction state

Leave codes

KErrSIPResourceNotAvailable if a required SIP Client API object has been deleted

IMPORT_C TBool IsSIPClientTransaction() const;

Description

Checks the if the actual object is of type CSIPClientTransaction.

Return value

TBool ETrue if object is of type CSIPClientTransaction and EFalse otherwise

IMPORT_C TBool operator==(const CSIPTransactionBase &aTransaction) const;

Description

Compares this object to another object also having CSIPTransactionBase base class The function has to be implemented in each of the sub-classes.

Parameters

const CSIPTransactionBase &aTransaction a CSIPTransactionBase object to compare

Return value

TBool ETrue if the objects are equal otherwise EFalse

TState

Description

SIP transaction state

ETrying Trying state ECalling Calling state EProceeding Proceeding state ECompleted Completed state EConfirmed Confirmed state ETerminated Terminated state EConstructing Object is being constructed and is not yet ready for use