Class CSIPContactHeader

class CSIPContactHeader : public CSIPParameterHeaderBase;

Description

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

sipcodec.lib

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CSIPHeaderBase - Class provides a generic interface for all the SIP headers

• CSIPParameterHeaderBase - A base class for SIP headers that have structure "mandatory part"delimiter"parameters"

• CSIPContactHeader - Class provides functions for setting and getting SIP "Contact" header fields

Members

Defined in CSIPContactHeader:
CloneL(), DecodeL(), ExpiresParameter(), InternalizeValueL(), Name(), NewL(), NewLC(), QParameter(), SIPAddress(), SIPAddress(), SetExpiresParameterL(), SetQParameterL(), SetSIPAddressL(), Star(), operator==(), ~CSIPContactHeader()

Inherited from CBase:
Delete(), Extension_(), operator new()

Inherited from CSIPHeaderBase:
ExternalizeL(), ExternalizeSupported(), PushLC(), ToTextL(), ToTextLC(), ToTextValueLC()

Inherited from CSIPParameterHeaderBase:
DeleteParam(), HasParam(), Param(), ParamCount(), ParamValue(), SetParamL(), ToTextValueL()

static IMPORT_C CSIPContactHeader *NewL(CSIPAddress *aSIPAddress);

Pre-Condition

aSIPAddress != 0

Description

Creates a new instance of CSIPContactHeader

Parameters

CSIPAddress *aSIPAddress a name-address, the ownership is transferred

Return value

CSIPContactHeader * a new instance of CSIPContactHeader

static IMPORT_C CSIPContactHeader *NewLC(CSIPAddress *aSIPAddress);

Pre-Condition

aSIPAddress != 0

Description

Creates a new instance of CSIPContactHeader and puts it to CleanupStack

Parameters

CSIPAddress *aSIPAddress a name-address, the ownership is transferred

Return value

CSIPContactHeader * a new instance of CSIPContactHeader

IMPORT_C ~CSIPContactHeader();

Description

Destructor, deletes the resources of CSIPContactHeader.

static IMPORT_C RPointerArray< CSIPContactHeader > DecodeL(const TDesC8 &aValue);

Description

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

Return value

RPointerArray< CSIPContactHeader > an array containing 1..n instances of CSIPContactHeader

IMPORT_C TBool operator==(const CSIPContactHeader &aHeader) const;

Description

Compares this object to another instance of CSIPContactHeader

Parameters

const CSIPContactHeader &aHeader a CSIPContactHeader header to compare to

Return value

TBool ETrue if the objects are equal otherwise EFalse

IMPORT_C TBool Star() const;

Description

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

Return value

TBool ETrue, if the address is a "*" otherwise EFalse

IMPORT_C TInt ExpiresParameter() const;

Description

Gets the value of the "expires"-parameter

Return value

TInt the "expires"-parameter, or KErrNotFound if the parameter is not present.

IMPORT_C void SetExpiresParameterL(TInt aExpiresParam);

Pre-Condition

aExpiresParam >= 0

Description

Sets the "expires"-parameter

Parameters

TInt aExpiresParam a "expires"-parameter value to set

IMPORT_C TReal QParameter() const;

Pre-Condition

Star() == EFalse

Description

Gets the value of "q"-parameter

Return value

TReal the "q"-parameter value, or zero if the parameter is not present.

IMPORT_C void SetQParameterL(TReal aQValue);

Pre-Condition

Star() == EFalse

Description

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

Parameters

TReal aQValue a "q"-parameter value to set

IMPORT_C const CSIPAddress *SIPAddress() const;

Description

Gets the name-address as const

Return value

const CSIPAddress * name-address or 0 if not present The ownership is NOT transferred.

IMPORT_C CSIPAddress *SIPAddress();

Description

Gets the name-address

Return value

CSIPAddress * name-address or 0 if not present The ownership is NOT transferred.

IMPORT_C void SetSIPAddressL(CSIPAddress *aSIPAddress);

Pre-Condition

Star() == EFalse

aSIPAddress != 0

Description

Sets the name-address

Parameters

CSIPAddress *aSIPAddress a name-address to set, the ownership is transferred

static IMPORT_C CSIPHeaderBase *InternalizeValueL(RReadStream &aReadStream);

Description

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

Return value

CSIPHeaderBase * an instance of a CSIPContactHeader

virtual IMPORT_C CSIPHeaderBase *CloneL() const;

Description

From CSIPHeaderBase CloneL

Return value

CSIPHeaderBase *

virtual IMPORT_C RStringF Name() const;

Description

From CSIPHeaderBase Name

Return value

RStringF