CSIPSubscriptionStateHeader Class Reference

#include <mw/sipsubscriptionstateheader.h>

Link against: sipcodec.lib

class CSIPSubscriptionStateHeader : public CSIPParameterHeaderBase

Inherits from

Public Member Functions
~CSIPSubscriptionStateHeader()
RPointerArray< CSIPHeaderBase >BaseDecodeL(const TDesC8 &)
virtual IMPORT_C CSIPHeaderBase *CloneL()
IMPORT_C CSIPSubscriptionStateHeader *DecodeL(const TDesC8 &)
IMPORT_C TIntExpiresParameter()
IMPORT_C CSIPHeaderBase *InternalizeValueL(RReadStream &)
virtual IMPORT_C RStringFName()
IMPORT_C CSIPSubscriptionStateHeader *NewL(const TDesC8 &)
IMPORT_C CSIPSubscriptionStateHeader *NewLC(const TDesC8 &)
virtual TPreferredPlace PreferredPlaceInMessage()
IMPORT_C TIntRetryAfterParameter()
IMPORT_C voidSetExpiresParameterL(TInt)
IMPORT_C voidSetRetryAfterParameterL(TInt)
IMPORT_C voidSetSubStateValueL(const TDesC8 &)
IMPORT_C const TDesC8 &SubStateValue()
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 SIP "Subscription-State" header fields.

Constructor & Destructor Documentation

~CSIPSubscriptionStateHeader ( )

IMPORT_C~CSIPSubscriptionStateHeader()

Destructor, deletes the resources of CSIPSubscriptionStateHeader.

Member Function Documentation

BaseDecodeL ( const TDesC8 & )

RPointerArray< CSIPHeaderBase >BaseDecodeL(const TDesC8 &aValue)[static]

CloneL ( )

IMPORT_C CSIPHeaderBase *CloneL()const [virtual]

From CSIPHeaderBase CloneL

DecodeL ( const TDesC8 & )

IMPORT_C CSIPSubscriptionStateHeader *DecodeL(const TDesC8 &aValue)[static]

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

ParameterDescription
aValuea value part of a "Subscription-State"-header

Returns: a new instance of CSIPSubscriptionStateHeader

ExpiresParameter ( )

IMPORT_C TIntExpiresParameter()const

Gets the value of the "expires"-parameter

Returns: "expires"-parameter or KErrNotFound if not present

InternalizeValueL ( RReadStream & )

IMPORT_C CSIPHeaderBase *InternalizeValueL(RReadStream &aReadStream)[static]

Constructs an instance of a CSIPSubscriptionStateHeader from a RReadStream

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

Returns: an instance of a CSIPSubscriptionStateHeader

Name ( )

IMPORT_C RStringFName()const [virtual]

Reimplemented from CSIPHeaderBase::Name()const

From CSIPHeaderBase Name

NewL ( const TDesC8 & )

IMPORT_C CSIPSubscriptionStateHeader *NewL(const TDesC8 &aSubStateValue)[static]

Creates a new instance of CSIPSubscriptionStateHeader

ParameterDescription
aSubStateValuea substate-value value

Returns: a new instance of CSIPSubscriptionStateHeader

NewLC ( const TDesC8 & )

IMPORT_C CSIPSubscriptionStateHeader *NewLC(const TDesC8 &aSubStateValue)[static]

Creates a new instance of CSIPSubscriptionStateHeader and puts it to CleanupStack

ParameterDescription
aSubStateValuea substate-value value

Returns: a new instance of CSIPSubscriptionStateHeader

PreferredPlaceInMessage ( )

TPreferredPlace PreferredPlaceInMessage()const [virtual]

RetryAfterParameter ( )

IMPORT_C TIntRetryAfterParameter()const

Gets the value of the "retry-after"-parameter

Returns: "retry-after"-parameter or KErrNotFound if not present

SetExpiresParameterL ( TInt )

IMPORT_C voidSetExpiresParameterL(TIntaExpiresParam)
Sets the "expires"-parameter
Pre-condition
aExpiresParam >= 0
ParameterDescription
aExpiresParama "expires"-parameter value to set

SetRetryAfterParameterL ( TInt )

IMPORT_C voidSetRetryAfterParameterL(TIntaRetryAfterParam)
Sets the "retry-after"-parameter
Pre-condition
aRetryAfterParam >= 0
ParameterDescription
aRetryAfterParama "retry-after"-parameter value to set

SetSubStateValueL ( const TDesC8 & )

IMPORT_C voidSetSubStateValueL(const TDesC8 &aSubStateValue)

Sets the substate-value parameter in the "Subscription-State" header;

ParameterDescription
aSubStateValuea substate-value parameter to set

SubStateValue ( )

IMPORT_C const TDesC8 &SubStateValue()const

Gets the substate-value parameter from the "Subscription-State" header

Returns: the substate-value parameter

© Nokia 2011.