Collapse all Symbian^3 Product Developer Library

CSIPContactHeader Class Reference

class CSIPContactHeader : public CSIPParameterHeaderBase

Class provides functions for setting and getting SIP "Contact" header fields.

sipcodec.lib

Inherits from

CSIPContactHeader
- CSIPParameterHeaderBase
  - CSIPHeaderBase
    - CBase

Public Member Functions
	~CSIPContactHeader()
RPointerArray< CSIPHeaderBase >	BaseDecodeL(const TDesC8 &)
IMPORT_C CSIPHeaderBase *	CloneL()
RStringF	CompactName()
IMPORT_C RPointerArray< CSIPContactHeader >	DecodeL(const TDesC8 &)
IMPORT_C TInt	ExpiresParameter()
TBool	HasCompactName()
IMPORT_C CSIPHeaderBase *	InternalizeValueL(RReadStream &)
TBool	MoreThanOneAllowed()
IMPORT_C RStringF	Name()
IMPORT_C CSIPContactHeader *	NewL(CSIPAddress *)
IMPORT_C CSIPContactHeader *	NewLC(CSIPAddress *)
TPreferredPlace	PreferredPlaceInMessage()
IMPORT_C TReal	QParameter()
IMPORT_C void	RemoveExpiresParam()
IMPORT_C const CSIPAddress *	SIPAddress()
IMPORT_C CSIPAddress *	SIPAddress()
IMPORT_C void	SetExpiresParameterL(TInt)
IMPORT_C void	SetQParameterL(TReal)
IMPORT_C void	SetSIPAddressL(CSIPAddress *)
IMPORT_C TBool	Star()
IMPORT_C TBool	operator==(const CSIPContactHeader &)

Private Member Functions
	CSIPContactHeader(TBool)
void	ConstructL()
void	ConstructL(CSIPAddress *)
void	ConstructL(const CSIPContactHeader &)
void	DoInternalizeValueL(RReadStream &)
void	ExternalizeValueL(RWriteStream &)
TBool	ParamInsertionAllowed()
const CSIPParamContainerBase &	Params()
CSIPParamContainerBase &	Params()
void	ParseMandatoryPartL(const TDesC8 &)
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::PushLC(RPointerArray< CSIPHeaderBase > *)
	CSIPHeaderBase::ResetAndDestroy(TAny *)
	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::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
TBool	iIsStar
CSIPContactHeaderParams *	iParams
CSIPAddress *	iSIPAddress

Inherited Attributes
	CSIPHeaderBase::iLink

Constructor & Destructor Documentation

CSIPContactHeader(TBool)

CSIPContactHeader

(

TBool

aIsStar = EFalse

)

[private]

Parameters

TBool aIsStar = EFalse

~CSIPContactHeader()

IMPORT_C

~CSIPContactHeader

(

)

Destructor, deletes the resources of CSIPContactHeader.

Member Functions Documentation

BaseDecodeL(const TDesC8 &)

RPointerArray< CSIPHeaderBase >

BaseDecodeL

(

const TDesC8 &

aValue

)

[static]

Parameters

const TDesC8 & aValue

CloneL()

IMPORT_C CSIPHeaderBase *

CloneL

(

)

const [virtual]

From CSIPHeaderBase CloneL

CompactName()

RStringF

CompactName

(

)

const [virtual]

ConstructL()

void

ConstructL

(

)

[private]

ConstructL(CSIPAddress *)

void

ConstructL

(

CSIPAddress *

aSIPAddress

)

[private]

Parameters

CSIPAddress * aSIPAddress

ConstructL(const CSIPContactHeader &)

void

ConstructL

(

const CSIPContactHeader &

aContactHeader

)

[private]

Parameters

const CSIPContactHeader & aContactHeader

DecodeL(const TDesC8 &)

IMPORT_C RPointerArray< CSIPContactHeader >

DecodeL

(

const TDesC8 &

aValue

)

[static]

Constructs a CSIPContactHeader from textual representation of the header's value part. Note that "Contact: *" can be only created using this function.

Parameters

const TDesC8 & aValue

a value part of a "Contact"-header

DoInternalizeValueL(RReadStream &)

void

DoInternalizeValueL

(

RReadStream &

aReadStream

)

[private]

Parameters

RReadStream & aReadStream

ExpiresParameter()

IMPORT_C TInt

ExpiresParameter

(

)

const

Gets the value of the "expires"-parameter

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 CSIPContactHeader from a RReadStream

Parameters

RReadStream & aReadStream

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

MoreThanOneAllowed()

TBool

MoreThanOneAllowed

(

)

const [virtual]

Name()

IMPORT_C RStringF

Name

(

)

const [virtual]

From CSIPHeaderBase Name

NewL(CSIPAddress *)

IMPORT_C CSIPContactHeader *

NewL

(

CSIPAddress *

aSIPAddress

)

[static]

Creates a new instance of CSIPContactHeader

Pre-condition: aSIPAddress != 0

Parameters

CSIPAddress * aSIPAddress

a name-address, the ownership is transferred

NewLC(CSIPAddress *)

IMPORT_C CSIPContactHeader *

NewLC

(

CSIPAddress *

aSIPAddress

)

[static]

Creates a new instance of CSIPContactHeader and puts it to CleanupStack

Pre-condition: aSIPAddress != 0

Parameters

CSIPAddress * aSIPAddress

a name-address, the ownership is transferred

ParamInsertionAllowed()

TBool

ParamInsertionAllowed

(

)

const [private, virtual]

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]

QParameter()

IMPORT_C TReal

QParameter

(

)

const

Gets the value of "q"-parameter

Pre-condition: Star() == EFalse

RemoveExpiresParam()

IMPORT_C void

RemoveExpiresParam

(

)

Removes the "expires"-parameter

SIPAddress()

IMPORT_C const CSIPAddress *

SIPAddress

(

)

const

Gets the name-address as const

SIPAddress()

IMPORT_C CSIPAddress *

SIPAddress

(

)

Gets the name-address

SetExpiresParameterL(TInt)

IMPORT_C void

SetExpiresParameterL

(

TInt

aExpiresParam

)

Sets the "expires"-parameter

Pre-condition: aExpiresParam >= 0

Parameters

TInt aExpiresParam

a "expires"-parameter value to set

SetQParameterL(TReal)

IMPORT_C void

SetQParameterL

(

TReal

aQValue

)

Sets the "q"-parameter value in the "Contact" header

Pre-condition: Star() == EFalse

Parameters

TReal aQValue

a "q"-parameter value to set

SetSIPAddressL(CSIPAddress *)

IMPORT_C void

SetSIPAddressL

(

CSIPAddress *

aSIPAddress

)

Sets the name-address

Pre-condition: Star() == EFalse; aSIPAddress != 0

Parameters

CSIPAddress * aSIPAddress

a name-address to set, the ownership is transferred

Star()

IMPORT_C TBool

Star

(

)

const

Checks if the address is set to a STAR ("*")

ToTextMandatoryPartLC()

HBufC8 *

ToTextMandatoryPartLC

(

)

const [private, virtual]

operator==(const CSIPContactHeader &)

IMPORT_C TBool

operator==

(

const CSIPContactHeader &

aHeader

)

const

Compares this object to another instance of CSIPContactHeader

Parameters

const CSIPContactHeader & aHeader

a CSIPContactHeader header to compare to

Member Data Documentation

TBool iIsStar

TBool

iIsStar

[private]

CSIPContactHeaderParams * iParams

CSIPContactHeaderParams *

iParams

[private]

CSIPAddress * iSIPAddress

CSIPAddress *

iSIPAddress

[private]