Symbian^3 Application Developer Library >

CSIPEventHeader Class Reference

class CSIPEventHeader : public CSIPParameterHeaderBase

Class provides functions for setting and getting parameters in SIP "Event" header.

sipcodec.lib

Inherits from

Public Member Functions
~CSIPEventHeader ()
RPointerArray < CSIPHeaderBase > BaseDecodeL (const TDesC8 &)
IMPORT_C CSIPHeaderBase * CloneL ()
RStringF CompactName ()
IMPORT_C CSIPEventHeader * DecodeL (const TDesC8 &)
IMPORT_C const TDesC8 & EventPackage ()
IMPORT_C const MDesC8Array & EventTemplates ()
TBool HasCompactName ()
IMPORT_C CSIPHeaderBase * InternalizeValueL ( RReadStream &)
IMPORT_C RStringF Name ()
IMPORT_C CSIPEventHeader * NewL (const TDesC8 &)
IMPORT_C CSIPEventHeader * NewLC (const TDesC8 &)
TPreferredPlace PreferredPlaceInMessage ()
IMPORT_C void SetEventPackageL (const TDesC8 &)
IMPORT_C void SetEventTemplatesL (const MDesC8Array &)
IMPORT_C TBool operator== (const CSIPEventHeader &)
Private Member Functions
CSIPEventHeader ()
void CheckTemplateL (const TDesC8 &)
void ConstructL ()
void ConstructL (const TDesC8 &)
void ConstructL (const CSIPEventHeader &)
void DoInternalizeValueL ( RReadStream &)
void ExternalizeValueL ( RWriteStream &)
const CSIPParamContainerBase & Params ()
CSIPParamContainerBase & Params ()
void ParseMandatoryPartL (const TDesC8 &)
void ResetAndDestroy ( TAny *)
HBufC8 * ToTextMandatoryPartLC ()
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()
CSIPHeaderBase::CSIPHeaderBase()
CSIPHeaderBase::EncodeMultipleToOneLine()const
CSIPHeaderBase::ExternalizeL(RWriteStream &,TBool)const
CSIPHeaderBase::ExternalizeNameL(RWriteStream &)const
CSIPHeaderBase::ExternalizeSupported()const
CSIPHeaderBase::IsExtensionHeader()const
CSIPHeaderBase::MoreThanOneAllowed()const
CSIPHeaderBase::PushLC(RPointerArray< CSIPHeaderBase > *)
CSIPHeaderBase::ToTextL()const
CSIPHeaderBase::ToTextLC()const
CSIPHeaderBase::ToTextValueLC()const
CSIPHeaderBase::~CSIPHeaderBase()
CSIPParameterHeaderBase::CSIPParameterHeaderBase(const TChar &)
CSIPParameterHeaderBase::DeleteParam(RStringF)
CSIPParameterHeaderBase::HasParam(RStringF)const
CSIPParameterHeaderBase::Param(TInt,RStringF &)const
CSIPParameterHeaderBase::ParamCount()const
CSIPParameterHeaderBase::ParamInsertionAllowed()const
CSIPParameterHeaderBase::ParamValue(RStringF)const
CSIPParameterHeaderBase::ParseL(const TDesC8 &,TBool,TBool)
CSIPParameterHeaderBase::SetParamL(RStringF)
CSIPParameterHeaderBase::SetParamL(RStringF,RStringF)
CSIPParameterHeaderBase::ToTextValueL()const
CSIPParameterHeaderBase::~CSIPParameterHeaderBase()
Inherited Enumerations
CSIPHeaderBase:TPreferredPlace
Private Attributes
HBufC8 * iEventPackage
CDesC8ArraySeg * iEventTemplates
CSIPEventHeaderParams * iParams
Inherited Attributes
CSIPHeaderBase::iLink

Constructor & Destructor Documentation

CSIPEventHeader()

CSIPEventHeader ( ) [private]

~CSIPEventHeader()

IMPORT_C ~CSIPEventHeader ( )

Destructor, deletes the resources of CSIPEventHeader .

Member Functions Documentation

BaseDecodeL(const TDesC8 &)

RPointerArray < CSIPHeaderBase > BaseDecodeL ( const TDesC8 & aValue ) [static]

Parameters

const TDesC8 & aValue

CheckTemplateL(const TDesC8 &)

void CheckTemplateL ( const TDesC8 & aParam ) const [private]

Parameters

const TDesC8 & aParam

CloneL()

IMPORT_C CSIPHeaderBase * CloneL ( ) const [virtual]

From CSIPHeaderBase CloneL

CompactName()

RStringF CompactName ( ) const [virtual]

ConstructL()

void ConstructL ( ) [private]

ConstructL(const TDesC8 &)

void ConstructL ( const TDesC8 & aEventPackage ) [private]

Parameters

const TDesC8 & aEventPackage

ConstructL(const CSIPEventHeader &)

void ConstructL ( const CSIPEventHeader & aSIPEventHeader ) [private]

Parameters

const CSIPEventHeader & aSIPEventHeader

DecodeL(const TDesC8 &)

IMPORT_C CSIPEventHeader * DecodeL ( const TDesC8 & aValue ) [static]

Constructs a CSIPEventHeader from textual representation of the header's value part.

Parameters

const TDesC8 & aValue a value part of a "Event"-header

DoInternalizeValueL(RReadStream &)

void DoInternalizeValueL ( RReadStream & aReadStream ) [private]

Parameters

RReadStream & aReadStream

EventPackage()

IMPORT_C const TDesC8 & EventPackage ( ) const

Gets the Event-Package parameter from the "Event" header

EventTemplates()

IMPORT_C const MDesC8Array & EventTemplates ( ) const

Gets the event templates.

ExternalizeValueL(RWriteStream &)

void ExternalizeValueL ( RWriteStream & aWriteStream ) const [private, virtual]

Parameters

RWriteStream & aWriteStream

HasCompactName()

TBool HasCompactName ( ) const [virtual]

InternalizeValueL(RReadStream &)

IMPORT_C CSIPHeaderBase * InternalizeValueL ( RReadStream & aReadStream ) [static]

Constructs an instance of a CSIPEventHeader from a RReadStream

Parameters

RReadStream & aReadStream a stream containing the value of the externalized object (header name not included).

Name()

IMPORT_C RStringF Name ( ) const [virtual]

From CSIPHeaderBase Name

NewL(const TDesC8 &)

IMPORT_C CSIPEventHeader * NewL ( const TDesC8 & aEventPackage ) [static]

Creates a new instance of CSIPEventHeader

Parameters

const TDesC8 & aEventPackage a Event-Package value

NewLC(const TDesC8 &)

IMPORT_C CSIPEventHeader * NewLC ( const TDesC8 & aEventPackage ) [static]

Creates a new instance of CSIPEventHeader and puts it to CleanupStack

Parameters

const TDesC8 & aEventPackage a Event-Package value

Params()

const CSIPParamContainerBase & Params ( ) const [private, virtual]

Params()

CSIPParamContainerBase & Params ( ) [private, virtual]

ParseMandatoryPartL(const TDesC8 &)

void ParseMandatoryPartL ( const TDesC8 & aMandatoryPart ) [private, virtual]

Parameters

const TDesC8 & aMandatoryPart

PreferredPlaceInMessage()

TPreferredPlace PreferredPlaceInMessage ( ) const [virtual]

ResetAndDestroy(TAny *)

void ResetAndDestroy ( TAny * anArray ) [private, static]

Parameters

TAny * anArray

SetEventPackageL(const TDesC8 &)

IMPORT_C void SetEventPackageL ( const TDesC8 & aEventPackage )

Sets the Event-Package parameter in the "Event" header;

Parameters

const TDesC8 & aEventPackage a Event-Package parameter to set

SetEventTemplatesL(const MDesC8Array &)

IMPORT_C void SetEventTemplatesL ( const MDesC8Array & aEventTemplates )

Sets the event templates overwriting all the existing ones.

Parameters

const MDesC8Array & aEventTemplates an array of event templates

ToTextMandatoryPartLC()

HBufC8 * ToTextMandatoryPartLC ( ) const [private, virtual]

operator==(const CSIPEventHeader &)

IMPORT_C TBool operator== ( const CSIPEventHeader & aHeader ) const

Compares this instance to another CSIPEventHeader instance

Parameters

const CSIPEventHeader & aHeader a header to compare to

Member Data Documentation

HBufC8 * iEventPackage

HBufC8 * iEventPackage [private]

CDesC8ArraySeg * iEventTemplates

CDesC8ArraySeg * iEventTemplates [private]

CSIPEventHeaderParams * iParams

CSIPEventHeaderParams * iParams [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.