CSIPTransactionBase Class Reference

#include <mw/siptransactionbase.h>

Link against: sipclient

class CSIPTransactionBase : public CBase

Inherits from

  • CSIPTransactionBase
    Protected Attributes
    MTransactionAssociation *iAssociation
    TUint32 iRequestId
    Public Member Enumerations
    enumTState { ETrying, ECalling, EProceeding, ECompleted, ..., EConstructing }
    Public Member Functions
    virtual ~CSIPTransactionBase()
    TBool AffectsDialogState()
    voidChangeState(CSIPTransactionBase::TState)
    virtual voidDetach(const MTransactionAssociation &)
    IMPORT_C TBoolIsSIPClientTransaction()
    TBool IsTargetRefresh(RStringF)
    TUint32 RequestId()
    voidSetAffectsDialogState()
    voidSetResponseElements(CSIPResponseElements *)
    IMPORT_C CSIPTransactionBase::TStateStateL()
    IMPORT_C RStringFType()
    IMPORT_C TBooloperator==(const CSIPTransactionBase &)
    Protected Member Functions
    CSIPTransactionBase(TBool, TUint32, MTransactionAssociation &)
    voidCheckAssociationL()
    voidConstructL(RStringF)
    const CSIPResponseElements *ResponseElements()
    Inherited Functions
    CBase::CBase()
    CBase::Delete(CBase *)
    CBase::Extension_(TUint,TAny *&,TAny *)
    CBase::operator new(TUint)
    CBase::operator new(TUint,TAny *)
    CBase::operator new(TUint,TLeave)
    CBase::operator new(TUint,TLeave,TUint)
    CBase::operator new(TUint,TUint)
    CBase::~CBase()

    Detailed 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.

    Member Attribute Documentation

    iAssociation

    MTransactionAssociation *iAssociation[protected]

    Every transaction is associated to exactly one other object: CSIP, CSIPConnection, CSIPRegistrationBinding or CSIPDialogAssocBase

    iRequestId

    TUint32 iRequestId[protected]

    RequestId received from SIP client

    Member Enumeration Documentation

    Enum TState

    SIP transaction state

    EnumeratorValueDescription
    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

    Constructor & Destructor Documentation

    CSIPTransactionBase ( TBool, TUint32, MTransactionAssociation & )

    CSIPTransactionBase(TBoolaIsClientTransaction,
    TUint32aRequestId,
    MTransactionAssociation &aAssociation
    )[protected]

    ~CSIPTransactionBase ( )

    ~CSIPTransactionBase()[virtual]

    Destructor

    Member Function Documentation

    AffectsDialogState ( )

    TBool AffectsDialogState()const

    Determines whether this transaction has an effect on the associated dialog's state.

    Returns: ETrue if transaction has an effect on the dialog's state, EFalse otherwise.

    ChangeState ( CSIPTransactionBase::TState )

    voidChangeState(CSIPTransactionBase::TStateaNextState)

    Changes the transaction state.

    ParameterDescription
    aNextStateState into which transaction moves

    CheckAssociationL ( )

    voidCheckAssociationL()const [protected]

    Checks that iAssociation is available (not NULL). If iAssociation is NULL, it means user has deleted a resource needed by CSIPTransactionBase, and this function leaves.

    ConstructL ( RStringF )

    voidConstructL(RStringFaType)[protected]

    Detach ( const MTransactionAssociation & )

    voidDetach(const MTransactionAssociation &aAssociation)[virtual]

    Clears the MTransactionAssociation. After this the object can't be used anymore and it is expected that user will delete it soon.

    ParameterDescription
    aAssociationObject requesting the detach

    IsSIPClientTransaction ( )

    IMPORT_C TBoolIsSIPClientTransaction()const

    Checks the if the actual object is of type CSIPClientTransaction.

    Returns: ETrue if object is of type CSIPClientTransaction and EFalse otherwise

    IsTargetRefresh ( RStringF )

    TBool IsTargetRefresh(RStringFaType)[static]

    Determines whether the transaction type is a target refresh request.

    ParameterDescription
    aTypeType of transaction

    Returns: ETrue If the transaction is a target refresh request, EFalse otherwise.

    RequestId ( )

    TUint32 RequestId()const

    Obtains the RequestId of the transaction.

    Returns: RequestId

    ResponseElements ( )

    const CSIPResponseElements *ResponseElements()const [protected]

    Gets response elements.

    Returns: Response elements. Ownership isn't transferred.

    SetAffectsDialogState ( )

    voidSetAffectsDialogState()

    Sets this transaction to affect the dialog state.

    SetResponseElements ( CSIPResponseElements * )

    voidSetResponseElements(CSIPResponseElements *aElements)

    Stores response elements. Depending on the status code, transaction may enter another state.

    ParameterDescription
    aElementsResponse elements, ownership is transferred.

    StateL ( )

    IMPORT_C CSIPTransactionBase::TStateStateL()
    Gets SIP transaction state
    leave
    KErrSIPResourceNotAvailable if a required SIP Client API object has been deleted

    Returns: SIP transaction state

    Type ( )

    IMPORT_C RStringFType()const

    Gets the SIP transaction type

    Returns: SIP transaction type

    operator== ( const CSIPTransactionBase & )

    IMPORT_C TBooloperator==(const CSIPTransactionBase &aTransaction)const

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

    ParameterDescription
    aTransactiona CSIPTransactionBase object to compare

    Returns: ETrue if the objects are equal otherwise EFalse

    © Nokia 2011.