CSIPDialogAssocBase Class Reference

#include <mw/sipdialogassocbase.h>

Link against: sipclient

class CSIPDialogAssocBase : public CBase

Inherits from

  • CSIPDialogAssocBase
    Protected Attributes
    CSIPDialogAssocImplementation *iImplementation
    Public Member Functions
    virtual ~CSIPDialogAssocBase()
    virtual voidDeletingRefresh(CSIPRefresh &, TUint32)
    IMPORT_C const CSIPDialog &Dialog()
    IMPORT_C CSIPDialog &Dialog()
    virtual CSIPRefresh *FindRefresh(TUint32)
    CSIPDialogAssocImplementation &Implementation()
    IMPORT_C TBoolIsNonTargetRefreshRequest(RStringF)
    virtual IMPORT_C CSIPClientTransaction *SendNonTargetRefreshRequestL(RStringF, CSIPMessageElements *)
    IMPORT_C RStringFType()
    Protected Member Functions
    CSIPDialogAssocBase()
    voidConstructL(RStringF, CSIPDialog &)
    voidConstructL(RStringF, CSIPDialog &, CSIPServerTransaction &)
    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 SIP dialog associations. It provides services for getting associated SIP dialog, actual dialog association type and for sending non target refresh requests within the dialog association.

    Member Attribute Documentation

    iImplementation

    CSIPDialogAssocImplementation *iImplementation[protected]

    Implementation instance, CSIPDialogAssocBase owns it

    Constructor & Destructor Documentation

    CSIPDialogAssocBase ( )

    CSIPDialogAssocBase()[protected]

    ~CSIPDialogAssocBase ( )

    ~CSIPDialogAssocBase()[virtual]

    Destructor

    Member Function Documentation

    ConstructL ( RStringF, CSIPDialog & )

    voidConstructL(RStringFaType,
    CSIPDialog &aDialog
    )[protected]

    ConstructL ( RStringF, CSIPDialog &, CSIPServerTransaction & )

    voidConstructL(RStringFaType,
    CSIPDialog &aDialog,
    CSIPServerTransaction &aTransaction
    )[protected]

    DeletingRefresh ( CSIPRefresh &, TUint32 )

    voidDeletingRefresh(CSIPRefresh &aRefresh,
    TUint32aRefreshId
    )[virtual]

    Dialog ( )

    IMPORT_C const CSIPDialog &Dialog()const

    Gets the dialog this dialog association belongs to

    Returns: associated dialog

    Dialog ( )

    IMPORT_C CSIPDialog &Dialog()

    Gets dialog this dialog association belongs to

    Returns: associated dialog

    FindRefresh ( TUint32 )

    CSIPRefresh *FindRefresh(TUint32aRefreshId)[virtual]

    Searches for a refresh with the matching id. Default implementation returns NULL. Those classes derived from CSIPDialogAssocBase, which can contain refreshes must implement this function for searching the correct refresh.

    Returns: CSIPRefresh if found, NULL otherwise. The ownership is not transferred.

    Implementation ( )

    CSIPDialogAssocImplementation &Implementation()

    Returns the implementation instance.

    Returns: CSIPDialogAssocImplementation

    IsNonTargetRefreshRequest ( RStringF )

    IMPORT_C TBoolIsNonTargetRefreshRequest(RStringFaMethod)const

    Tests if the request is a non target refresh request

    ParameterDescription
    aMethoda method to test

    Returns: ETrue if is non target refresh request; EFalse otherwise

    SendNonTargetRefreshRequestL ( RStringF, CSIPMessageElements * )

    IMPORT_C CSIPClientTransaction *SendNonTargetRefreshRequestL(RStringFaMethod,
    CSIPMessageElements *aElements
    )[virtual]
    Creates SIP request and sends it to the remote target. This function should be used for sending SIP extension requests within dialog assocation that do not cause sip dialog associations to be created. In SIP terms this request is non target refresh request.
    Pre-condition
    SIPDialog().State() != CSIPDialog::EInit && SIPDialog().State() != CSIPDialog::ETerminated

    Dialog().Connection().State() == EActive aMethod != "REGISTER" |"INVITE" | "BYE" | "CANCEL" | "ACK" | "SUBSCRIBE" | "NOTIFY" | "UPDATE" | "PRACK" | "REFER"

    leave
    KErrSIPInvalidDialogState If dialog's state is not correct
    leave
    KErrArgument if invalid value has been set to aMethod
    leave
    KErrSIPResourceNotAvailable if a required SIP Client API object has been deleted
    capability
    NetworkServices
    ParameterDescription
    aElementscontains optional SIP message headers and body. Ownership is transferred.

    Returns: SIP extension client transaction. Ownership is transferred.

    Type ( )

    IMPORT_C RStringFType()const

    Gets dialog association type.

    Returns: dialog association type e.g. "INVITE", "SUBSCRIBE" etc...

    © Nokia 2011.