CSIPRetryAfterHeader Class Reference

#include <mw/sipretryafterheader.h>

Link against: sipcodec.lib

class CSIPRetryAfterHeader : public CSIPParameterHeaderBase

Inherits from

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 TIntDurationParam()
IMPORT_C CSIPHeaderBase *InternalizeValueL(RReadStream &)
virtual IMPORT_C RStringFName()
IMPORT_C CSIPRetryAfterHeader *NewL(TUint)
IMPORT_C CSIPRetryAfterHeader *NewLC(TUint)
virtual TPreferredPlace PreferredPlaceInMessage()
IMPORT_C TUintRetryAfter()
IMPORT_C voidSetDurationParamL(TInt)
IMPORT_C voidSetRetryAfter(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]

From CSIPHeaderBase CloneL

Comment ( )

IMPORT_C const TDesC8 &Comment()const

Gets the comment value

Returns: 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.

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

Returns: a new instance of CSIPRetryAfterHeader

DurationParam ( )

IMPORT_C TIntDurationParam()const

Gets the value of the "duration"-parameter

Returns: 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

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

Returns: an instance of a CSIPRetryAfterHeader

Name ( )

IMPORT_C RStringFName()const [virtual]

Reimplemented from CSIPHeaderBase::Name()const

From CSIPHeaderBase Name

NewL ( TUint )

IMPORT_C CSIPRetryAfterHeader *NewL(TUintaRetryAfter)[static]

Creates a new instance of CSIPRetryAfterHeader

ParameterDescription
aRetryAftera retry after value.

Returns: a new instance of CSIPRetryAfterHeader

NewLC ( TUint )

IMPORT_C CSIPRetryAfterHeader *NewLC(TUintaRetryAfter)[static]

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

ParameterDescription
aRetryAftera retry after value.

Returns: a new instance of CSIPRetryAfterHeader

PreferredPlaceInMessage ( )

TPreferredPlace PreferredPlaceInMessage()const [virtual]

RetryAfter ( )

IMPORT_C TUintRetryAfter()const

Gets the retry after value

Returns: a retry after value

SetDurationParamL ( TInt )

IMPORT_C voidSetDurationParamL(TIntaDurationParam)
Sets the "duration"-parameter
Pre-condition
aDurationParam >= 0
ParameterDescription
aDurationParama "duration"-parameter value to set

SetRetryAfter ( TUint )

IMPORT_C voidSetRetryAfter(TUintaValue)

Sets the retry after value

ParameterDescription
aValuea new retry after value to set.