CSIPRetryAfterHeader Class Reference

#include <mw/sipretryafterheader.h>

Link against: sipcodec.lib

class CSIPRetryAfterHeader : public CSIPParameterHeaderBase

Inherits from

CSIPRetryAfterHeader
- CSIPParameterHeaderBase
  - CSIPHeaderBase
    - CBase

Public Member Functions
virtual	~CSIPRetryAfterHeader()
RPointerArray< CSIPHeaderBase >	BaseDecodeL(const TDesC8 &)
virtual IMPORT_C CSIPHeaderBase *	CloneL()
IMPORT_C const TDesC8 &	Comment()
IMPORT_C CSIPRetryAfterHeader *	DecodeL(const TDesC8 &)
IMPORT_C TInt	DurationParam()
IMPORT_C CSIPHeaderBase *	InternalizeValueL(RReadStream &)
virtual IMPORT_C RStringF	Name()
IMPORT_C CSIPRetryAfterHeader *	NewL(TUint)
IMPORT_C CSIPRetryAfterHeader *	NewLC(TUint)
virtual TPreferredPlace	PreferredPlaceInMessage()
IMPORT_C TUint	RetryAfter()
IMPORT_C void	SetDurationParamL(TInt)
IMPORT_C void	SetRetryAfter(TUint)

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::CompactName()const
	CSIPHeaderBase::EncodeMultipleToOneLine()const
	CSIPHeaderBase::ExternalizeL(RWriteStream &,TBool)const
	CSIPHeaderBase::ExternalizeNameL(RWriteStream &)const
	CSIPHeaderBase::ExternalizeSupported()const
	CSIPHeaderBase::HasCompactName()const
	CSIPHeaderBase::IsExtensionHeader()const
	CSIPHeaderBase::MoreThanOneAllowed()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::ParamInsertionAllowed()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 parameters in SIP "Retry-After" header.

Constructor & Destructor Documentation

~CSIPRetryAfterHeader ( )

IMPORT_C

~CSIPRetryAfterHeader

(

)

[virtual]

Destructor, deletes the resources of CSIPRetryAfterHeader.

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

Comment ( )

IMPORT_C const TDesC8 &

Comment

(

)

const

Gets the comment value

Return Value: a comment value or KNullDesC8

DecodeL ( const TDesC8 & )

IMPORT_C CSIPRetryAfterHeader *

DecodeL

(

const TDesC8 &

aValue

)

[static]

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

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

Return Value: a new instance of CSIPRetryAfterHeader

DurationParam ( )

IMPORT_C TInt

DurationParam

(

)

const

Gets the value of the "duration"-parameter

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

InternalizeValueL ( RReadStream & )

IMPORT_C CSIPHeaderBase *

InternalizeValueL

(

RReadStream &

aReadStream

)

[static]

Constructs an instance of a CSIPRetryAfterHeader from a RReadStream

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

Return Value: an instance of a CSIPRetryAfterHeader

Name ( )

IMPORT_C RStringF

Name

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::Name()const

From CSIPHeaderBase Name

NewL ( TUint )

IMPORT_C CSIPRetryAfterHeader *

NewL

(

TUint

aRetryAfter

)

[static]

Creates a new instance of CSIPRetryAfterHeader

Parameters
aRetryAfter	a retry after value.

Return Value: a new instance of CSIPRetryAfterHeader

NewLC ( TUint )

IMPORT_C CSIPRetryAfterHeader *

NewLC

(

TUint

aRetryAfter

)

[static]

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

Parameters
aRetryAfter	a retry after value.

Return Value: a new instance of CSIPRetryAfterHeader

PreferredPlaceInMessage ( )

TPreferredPlace

PreferredPlaceInMessage

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::PreferredPlaceInMessage()const

RetryAfter ( )

IMPORT_C TUint

RetryAfter

(

)

const

Gets the retry after value

Return Value: a retry after value

SetDurationParamL ( TInt )

IMPORT_C void

SetDurationParamL

(

TInt

aDurationParam

)

Sets the "duration"-parameter

Pre-condition: aDurationParam >= 0

Parameters
aDurationParam	a "duration"-parameter value to set

SetRetryAfter ( TUint )

IMPORT_C void

SetRetryAfter

(

TUint

aValue

)

Sets the retry after value

Parameters
aValue	a new retry after value to set.