CSIPHeaderBase Class Reference

#include <mw/sipheaderbase.h>

Link against: sipcodec.lib

class CSIPHeaderBase : public CBase

Inherits from

  • CSIPHeaderBase
    Public Attributes
    TSglQueLink iLink
    Public Member Enumerations
    enumTPreferredPlace { ETop, EMiddleTop, EMiddle, EMiddleBottom, EBottom }
    Public Member Functions
    virtual ~CSIPHeaderBase()
    pure virtual IMPORT_C CSIPHeaderBase *CloneL()
    virtual RStringF CompactName()
    virtual TBool EncodeMultipleToOneLine()
    IMPORT_C voidExternalizeL(RWriteStream &, TBool)
    virtual IMPORT_C TBoolExternalizeSupported()
    virtual TBool HasCompactName()
    virtual TBool IsExtensionHeader()
    virtual TBool MoreThanOneAllowed()
    pure virtual IMPORT_C RStringFName()
    pure virtual TPreferredPlace PreferredPlaceInMessage()
    IMPORT_C voidPushLC(RPointerArray< CSIPHeaderBase > *)
    IMPORT_C HBufC8 *ToTextL()
    IMPORT_C HBufC8 *ToTextLC()
    pure virtual IMPORT_C HBufC8 *ToTextValueL()
    IMPORT_C HBufC8 *ToTextValueLC()
    Protected Member Functions
    CSIPHeaderBase()
    voidExternalizeNameL(RWriteStream &)
    virtual voidExternalizeValueL(RWriteStream &)
    voidResetAndDestroy(TAny *)
    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 a generic interface for all the SIP headers.

    Member Attribute Documentation

    iLink

    TSglQueLink iLink

    Member Enumeration Documentation

    Enum TPreferredPlace

    EnumeratorValueDescription
    ETop
    EMiddleTop
    EMiddle
    EMiddleBottom
    EBottom

    Constructor & Destructor Documentation

    CSIPHeaderBase ( )

    CSIPHeaderBase()[protected]

    ~CSIPHeaderBase ( )

    IMPORT_C~CSIPHeaderBase()[virtual]

    Destructor, deletes the resources of CSIPHeaderBase.

    Member Function Documentation

    CloneL ( )

    IMPORT_C CSIPHeaderBase *CloneL()const [pure virtual]

    Creates a deep-copy of this CSIPHeaderBase object. The function has to be implemented in each of the sub-classes.

    Returns: the deep-copied object, the ownership is transferred.

    CompactName ( )

    RStringF CompactName()const [virtual]

    EncodeMultipleToOneLine ( )

    TBool EncodeMultipleToOneLine()const [virtual]

    ExternalizeL ( RWriteStream &, TBool )

    IMPORT_C voidExternalizeL(RWriteStream &aWriteStream,
    TBoolaAddName = ETrue
    )const

    Writes the object to a RWriteStream

    ParameterDescription
    aWriteStreama stream where the object is to be externalized
    aAddNameif ETrue the name of the header is also written to the stream

    ExternalizeNameL ( RWriteStream & )

    voidExternalizeNameL(RWriteStream &aWriteStream)const [protected]

    ExternalizeSupported ( )

    IMPORT_C TBoolExternalizeSupported()const [virtual]

    Checks, if the header supports serialization. In practice all the headers part of the API support it.

    Returns: ETrue, if the header supports serialization, otherwise EFalse

    ExternalizeValueL ( RWriteStream & )

    voidExternalizeValueL(RWriteStream &aWriteStream)const [protected, virtual]

    HasCompactName ( )

    TBool HasCompactName()const [virtual]

    IsExtensionHeader ( )

    TBool IsExtensionHeader()const [virtual]

    MoreThanOneAllowed ( )

    TBool MoreThanOneAllowed()const [virtual]

    Name ( )

    IMPORT_C RStringFName()const [pure virtual]

    Gets the full name of the header The function is implemented in each of the sub-classes.

    Returns: the full name of the header for example "From"

    PreferredPlaceInMessage ( )

    TPreferredPlace PreferredPlaceInMessage()const [pure virtual]

    PushLC ( RPointerArray< CSIPHeaderBase > * )

    IMPORT_C voidPushLC(RPointerArray< CSIPHeaderBase > *aArray)[static]

    Can be used when a RPointerArray<CSIPHeaderBase> needs to be pushed to the CleanupStack for ResetAndDestroy.

    ParameterDescription
    aArrayan array of CSIPHeaderBase pointers, the ownership of the array is transferred

    ResetAndDestroy ( TAny * )

    voidResetAndDestroy(TAny *anArray)[protected, static]

    ToTextL ( )

    IMPORT_C HBufC8 *ToTextL()const

    Encodes the header (name and value) into its textual representation.

    Returns: a textual representation of the complete header, the ownership is transferred

    ToTextLC ( )

    IMPORT_C HBufC8 *ToTextLC()const

    Encodes the header (name and value) into its textual representation and pushes it to the CleanupStack.

    Returns: a textual representation of the complete header, the ownership is transferred

    ToTextValueL ( )

    IMPORT_C HBufC8 *ToTextValueL()const [pure virtual]

    Encodes the header's value into its textual representation.

    Returns: a textual representation of the header's value, the ownership is transferred

    ToTextValueLC ( )

    IMPORT_C HBufC8 *ToTextValueLC()const

    Encodes the header's value into its textual representation and pushes it to the CleanupStack.

    Returns: a textual representation of the header's value, the ownership is transferred

    © Nokia 2011.