Class CSIPRetryAfterHeader

class CSIPRetryAfterHeader : public CSIPParameterHeaderBase;

Description

Class provides functions for setting and getting parameters in SIP "Retry-After" header.

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"

• CSIPRetryAfterHeader - Class provides functions for setting and getting parameters in SIP "Retry-After" header

Members

Defined in CSIPRetryAfterHeader:
CloneL(), Comment(), DecodeL(), DurationParam(), InternalizeValueL(), Name(), NewL(), NewLC(), RetryAfter(), SetDurationParamL(), SetRetryAfter(), ~CSIPRetryAfterHeader()

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 CSIPRetryAfterHeader *NewL(TUint aRetryAfter);

Description

Creates a new instance of CSIPRetryAfterHeader

Parameters

TUint aRetryAfter a retry after value.

Return value

CSIPRetryAfterHeader * a new instance of CSIPRetryAfterHeader

static IMPORT_C CSIPRetryAfterHeader *NewLC(TUint aRetryAfter);

Description

Creates a new instance of CSIPRetryAfterHeader On return the new instance has left to the CleanupStack.

Parameters

TUint aRetryAfter a retry after value.

Return value

CSIPRetryAfterHeader * a new instance of CSIPRetryAfterHeader

virtual IMPORT_C ~CSIPRetryAfterHeader();

Description

Destructor, deletes the resources of CSIPRetryAfterHeader.

static IMPORT_C CSIPRetryAfterHeader *DecodeL(const TDesC8 &aValue);

Description

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

Parameters

const TDesC8 &aValue a value part of a "Retry-After"-header (e.g. "18000;duration=3600")

Return value

CSIPRetryAfterHeader * a new instance of CSIPRetryAfterHeader

IMPORT_C void SetRetryAfter(TUint aValue);

Description

Sets the retry after value

Parameters

TUint aValue a new retry after value to set.

IMPORT_C TUint RetryAfter() const;

Description

Gets the retry after value

Return value

TUint a retry after value

IMPORT_C const TDesC8 &Comment() const;

Description

Gets the comment value

Return value

const TDesC8 & a comment value or KNullDesC8

IMPORT_C TInt DurationParam() const;

Description

Gets the value of the "duration"-parameter

Return value

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

IMPORT_C void SetDurationParamL(TInt aDurationParam);

Pre-Condition

aDurationParam >= 0

Description

Sets the "duration"-parameter

Parameters

TInt aDurationParam a "duration"-parameter value to set

static IMPORT_C CSIPHeaderBase *InternalizeValueL(RReadStream &aReadStream);

Description

Constructs an instance of a CSIPRetryAfterHeader 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 CSIPRetryAfterHeader

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