CSIPContactHeader Class Reference

#include <mw/sipcontactheader.h>

Link against: sipcodec.lib

class CSIPContactHeader : public CSIPParameterHeaderBase

Inherits from

CSIPContactHeader
- CSIPParameterHeaderBase
  - CSIPHeaderBase
    - CBase

Public Member Functions
	~CSIPContactHeader()
RPointerArray< CSIPHeaderBase >	BaseDecodeL(const TDesC8 &)
virtual IMPORT_C CSIPHeaderBase *	CloneL()
virtual RStringF	CompactName()
IMPORT_C RPointerArray< CSIPContactHeader >	DecodeL(const TDesC8 &)
IMPORT_C TInt	ExpiresParameter()
virtual TBool	HasCompactName()
IMPORT_C CSIPHeaderBase *	InternalizeValueL(RReadStream &)
virtual TBool	MoreThanOneAllowed()
virtual IMPORT_C RStringF	Name()
IMPORT_C CSIPContactHeader *	NewL(CSIPAddress *)
IMPORT_C CSIPContactHeader *	NewLC(CSIPAddress *)
virtual 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 &)

Inherited Attributes
	CSIPHeaderBase::iLink

Inherited Enumerations
	CSIPHeaderBase:TPreferredPlace

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()

Detailed Description

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

Constructor & Destructor Documentation

~CSIPContactHeader ( )

IMPORT_C

~CSIPContactHeader

(

)

Destructor, deletes the resources of CSIPContactHeader.

Member Function Documentation

BaseDecodeL ( const TDesC8 & )

RPointerArray< CSIPHeaderBase >

BaseDecodeL

(

const TDesC8 &

aValue

)

[static]

CloneL ( )

IMPORT_C CSIPHeaderBase *

CloneL

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::CloneL()const

From CSIPHeaderBase CloneL

CompactName ( )

RStringF

CompactName

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::CompactName()const

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
aValue	a value part of a "Contact"-header

Return Value: an array containing 1..n instances of CSIPContactHeader

ExpiresParameter ( )

IMPORT_C TInt

ExpiresParameter

(

)

const

Gets the value of the "expires"-parameter

Return Value: the "expires"-parameter, or KErrNotFound if the parameter is not present.

HasCompactName ( )

TBool

HasCompactName

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::HasCompactName()const

InternalizeValueL ( RReadStream & )

IMPORT_C CSIPHeaderBase *

InternalizeValueL

(

RReadStream &

aReadStream

)

[static]

Constructs an instance of a CSIPContactHeader from a RReadStream

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

Return Value: an instance of a CSIPContactHeader

MoreThanOneAllowed ( )

TBool

MoreThanOneAllowed

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::MoreThanOneAllowed()const

Name ( )

IMPORT_C RStringF

Name

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::Name()const

From CSIPHeaderBase Name

NewL ( CSIPAddress * )

IMPORT_C CSIPContactHeader *

NewL

(

CSIPAddress *

aSIPAddress

)

[static]

Creates a new instance of CSIPContactHeader

Pre-condition: aSIPAddress != 0

Parameters
aSIPAddress	a name-address, the ownership is transferred

Return Value: a new instance of CSIPContactHeader

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
aSIPAddress	a name-address, the ownership is transferred

Return Value: a new instance of CSIPContactHeader

PreferredPlaceInMessage ( )

TPreferredPlace

PreferredPlaceInMessage

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::PreferredPlaceInMessage()const

QParameter ( )

IMPORT_C TReal

QParameter

(

)

const

Gets the value of "q"-parameter

Pre-condition: Star() == EFalse

Return Value: the "q"-parameter value, or zero if the parameter is not present.

RemoveExpiresParam ( )

IMPORT_C void

RemoveExpiresParam

(

)

Removes the "expires"-parameter

SIPAddress ( )

IMPORT_C const CSIPAddress *

SIPAddress

(

)

const

Gets the name-address as const

Return Value: name-address or 0 if not present The ownership is NOT transferred.

SIPAddress ( )

IMPORT_C CSIPAddress *

SIPAddress

(

)

Gets the name-address

Return Value: name-address or 0 if not present The ownership is NOT transferred.

SetExpiresParameterL ( TInt )

IMPORT_C void

SetExpiresParameterL

(

TInt

aExpiresParam

)

Sets the "expires"-parameter

Pre-condition: aExpiresParam >= 0

Parameters
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
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
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 ("*")

Return Value: ETrue, if the address is a "*" otherwise EFalse

operator== ( const CSIPContactHeader & )

IMPORT_C TBool

operator==

(

const CSIPContactHeader &

aHeader

)

const

Compares this object to another instance of CSIPContactHeader

Parameters
aHeader	a CSIPContactHeader header to compare to

Return Value: ETrue if the objects are equal otherwise EFalse