CSIPResponseElements Class Reference

#include <mw/sipresponseelements.h>

Link against: sipclient.lib

class CSIPResponseElements : public CBase

Inherits from

  • CSIPResponseElements
    Public Member Functions
    ~CSIPResponseElements()
    IMPORT_C const CSIPCSeqHeader *CSeqHeader()
    voidExternalizeL(RWriteStream &)
    IMPORT_C const CSIPFromHeader *FromHeader()
    CSIPResponseElements *InternalizeL(RReadStream &)
    CSIPResponseElements *InternalizeLC(RReadStream &)
    IMPORT_C const CSIPMessageElements &MessageElements()
    IMPORT_C CSIPMessageElements &MessageElements()
    IMPORT_C CSIPResponseElements *NewL(TUint, RStringF)
    IMPORT_C CSIPResponseElements *NewLC(TUint, RStringF)
    IMPORT_C RStringFReasonPhrase()
    IMPORT_C voidSetReasonPhraseL(RStringF)
    IMPORT_C voidSetStatusCodeL(TUint)
    IMPORT_C TUintStatusCode()
    IMPORT_C const CSIPToHeader *ToHeader()
    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

    Class provides services for creating and manipulating SIP responses This class is used for creating and manipulating SIP responses including status code, reason phrase and optional elements such user headers, content and its type.

    Constructor & Destructor Documentation

    ~CSIPResponseElements ( )

    IMPORT_C~CSIPResponseElements()

    Destructor.

    Member Function Documentation

    CSeqHeader ( )

    IMPORT_C const CSIPCSeqHeader *CSeqHeader()const

    Gets CSeq-header

    Returns: a CSeq-header or a 0-pointer if not present. Ownership is not transferred.

    ExternalizeL ( RWriteStream & )

    voidExternalizeL(RWriteStream &aWriteStream)const

    FromHeader ( )

    IMPORT_C const CSIPFromHeader *FromHeader()const

    Gets the originator's From-header

    Returns: a From-header or a 0-pointer if not present. Ownership is not transferred.

    InternalizeL ( RReadStream & )

    CSIPResponseElements *InternalizeL(RReadStream &aReadStream)[static]

    InternalizeLC ( RReadStream & )

    CSIPResponseElements *InternalizeLC(RReadStream &aReadStream)[static]

    MessageElements ( )

    IMPORT_C const CSIPMessageElements &MessageElements()const

    Gets message elements (contains all SIP user headers and content)

    Returns: message elements

    MessageElements ( )

    IMPORT_C CSIPMessageElements &MessageElements()

    Gets message elements (contains all SIP user headers and content) The response elements can be populated with SIP user headers and content using returned reference to the message elements.

    Returns: message elements

    NewL ( TUint, RStringF )

    IMPORT_C CSIPResponseElements *NewL(TUintaStatusCode,
    RStringFaReasonPhrase
    )[static]
    Two-phased constructor.
    Pre-condition
    aStatusCode > 100 && aStatusCode < 700
    ParameterDescription
    aStatusCodea known SIP response status code. Cannot be 100.
    aReasonPhrasea SIP response reason phrase.

    NewLC ( TUint, RStringF )

    IMPORT_C CSIPResponseElements *NewLC(TUintaStatusCode,
    RStringFaReasonPhrase
    )[static]
    Two-phased constructor.
    Pre-condition
    aStatusCode > 100 && aStatusCode < 700
    ParameterDescription
    aStatusCodea known SIP response status code. Cannot be 100.
    aReasonPhrasea SIP response reason phrase.

    ReasonPhrase ( )

    IMPORT_C RStringFReasonPhrase()const

    Gets a SIP Response Reason Phrase.

    Returns: a SIP response reason phrase or an empty string if the reason phrase is not defined.

    SetReasonPhraseL ( RStringF )

    IMPORT_C voidSetReasonPhraseL(RStringFaReasonPhrase)

    Sets a SIP Response Reason Phrase.

    ParameterDescription
    aReasonPhrasea SIP response reason phrase.

    SetStatusCodeL ( TUint )

    IMPORT_C voidSetStatusCodeL(TUintaStatusCode)
    Sets a SIP Response extension status code. It is not possible to set value 100.
    Pre-condition
    aStatusCode > 100 && aStatusCode < 700
    leave
    KErrArgument if aStatusCode < 100 or aStatusCode >= 700
    ParameterDescription
    aStatusCodeextension status code

    StatusCode ( )

    IMPORT_C TUintStatusCode()const

    Gets the SIP Response status code

    Returns: SIP Response status code

    ToHeader ( )

    IMPORT_C const CSIPToHeader *ToHeader()const

    Gets the recipient's To-header

    Returns: a To-header or a 0-pointer if not present. Ownership is not transferred.

    © Nokia 2011.