Collapse all Symbian^3 Product Developer Library

CSIPSubscriptionStateHeader Class Reference

class CSIPSubscriptionStateHeader : public CSIPParameterHeaderBase

Class provides functions for setting and getting SIP "Subscription-State" header fields.

sipcodec.lib

Inherits from

CSIPSubscriptionStateHeader
- CSIPParameterHeaderBase
  - CSIPHeaderBase
    - CBase

Public Member Functions
	~CSIPSubscriptionStateHeader()
RPointerArray< CSIPHeaderBase >	BaseDecodeL(const TDesC8 &)
IMPORT_C CSIPHeaderBase *	CloneL()
IMPORT_C CSIPSubscriptionStateHeader *	DecodeL(const TDesC8 &)
IMPORT_C TInt	ExpiresParameter()
IMPORT_C CSIPHeaderBase *	InternalizeValueL(RReadStream &)
IMPORT_C RStringF	Name()
IMPORT_C CSIPSubscriptionStateHeader *	NewL(const TDesC8 &)
IMPORT_C CSIPSubscriptionStateHeader *	NewLC(const TDesC8 &)
TPreferredPlace	PreferredPlaceInMessage()
IMPORT_C TInt	RetryAfterParameter()
IMPORT_C void	SetExpiresParameterL(TInt)
IMPORT_C void	SetRetryAfterParameterL(TInt)
IMPORT_C void	SetSubStateValueL(const TDesC8 &)
IMPORT_C const TDesC8 &	SubStateValue()

Private Member Functions
	CSIPSubscriptionStateHeader()
void	ConstructL()
void	ConstructL(const TDesC8 &)
void	ConstructL(const CSIPSubscriptionStateHeader &)
void	DoInternalizeValueL(RReadStream &)
void	ExternalizeValueL(RWriteStream &)
const CSIPParamContainerBase &	Params()
CSIPParamContainerBase &	Params()
void	ParseMandatoryPartL(const TDesC8 &)
HBufC8 *	ToTextMandatoryPartLC()

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

Inherited Enumerations
	CSIPHeaderBase:TPreferredPlace

Private Attributes
CSIPSubscriptionStateHeaderParams *	iParams
HBufC8 *	iSubStateValue

Inherited Attributes
	CSIPHeaderBase::iLink

Constructor & Destructor Documentation

CSIPSubscriptionStateHeader()

CSIPSubscriptionStateHeader

(

)

[private]

~CSIPSubscriptionStateHeader()

IMPORT_C

~CSIPSubscriptionStateHeader

(

)

Destructor, deletes the resources of CSIPSubscriptionStateHeader.

Member Functions Documentation

BaseDecodeL(const TDesC8 &)

RPointerArray< CSIPHeaderBase >

BaseDecodeL

(

const TDesC8 &

aValue

)

[static]

Parameters

const TDesC8 & aValue

CloneL()

IMPORT_C CSIPHeaderBase *

CloneL

(

)

const [virtual]

From CSIPHeaderBase CloneL

ConstructL()

void

ConstructL

(

)

[private]

ConstructL(const TDesC8 &)

void

ConstructL

(

const TDesC8 &

aSubStateValue

)

[private]

Parameters

const TDesC8 & aSubStateValue

ConstructL(const CSIPSubscriptionStateHeader &)

void

ConstructL

(

const CSIPSubscriptionStateHeader &

aSubscriptionStateHeader

)

[private]

Parameters

const CSIPSubscriptionStateHeader & aSubscriptionStateHeader

DecodeL(const TDesC8 &)

IMPORT_C CSIPSubscriptionStateHeader *

DecodeL

(

const TDesC8 &

aValue

)

[static]

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

Parameters

const TDesC8 & aValue

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

DoInternalizeValueL(RReadStream &)

void

DoInternalizeValueL

(

RReadStream &

aReadStream

)

[private]

Parameters

RReadStream & aReadStream

ExpiresParameter()

IMPORT_C TInt

ExpiresParameter

(

)

const

Gets the value of the "expires"-parameter

ExternalizeValueL(RWriteStream &)

void

ExternalizeValueL

(

RWriteStream &

aWriteStream

)

const [private, virtual]

Parameters

RWriteStream & aWriteStream

InternalizeValueL(RReadStream &)

IMPORT_C CSIPHeaderBase *

InternalizeValueL

(

RReadStream &

aReadStream

)

[static]

Constructs an instance of a CSIPSubscriptionStateHeader from a RReadStream

Parameters

RReadStream & aReadStream

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

Name()

IMPORT_C RStringF

Name

(

)

const [virtual]

From CSIPHeaderBase Name

NewL(const TDesC8 &)

IMPORT_C CSIPSubscriptionStateHeader *

NewL

(

const TDesC8 &

aSubStateValue

)

[static]

Creates a new instance of CSIPSubscriptionStateHeader

Parameters

const TDesC8 & aSubStateValue

a substate-value value

NewLC(const TDesC8 &)

IMPORT_C CSIPSubscriptionStateHeader *

NewLC

(

const TDesC8 &

aSubStateValue

)

[static]

Creates a new instance of CSIPSubscriptionStateHeader and puts it to CleanupStack

Parameters

const TDesC8 & aSubStateValue

a substate-value value

Params()

const CSIPParamContainerBase &

Params

(

)

const [private, virtual]

Params()

CSIPParamContainerBase &

Params

(

)

[private, virtual]

ParseMandatoryPartL(const TDesC8 &)

void

ParseMandatoryPartL

(

const TDesC8 &

aMandatoryPart

)

[private, virtual]

Parameters

const TDesC8 & aMandatoryPart

PreferredPlaceInMessage()

TPreferredPlace

PreferredPlaceInMessage

(

)

const [virtual]

RetryAfterParameter()

IMPORT_C TInt

RetryAfterParameter

(

)

const

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

SetExpiresParameterL(TInt)

IMPORT_C void

SetExpiresParameterL

(

TInt

aExpiresParam

)

Sets the "expires"-parameter

Pre-condition: aExpiresParam >= 0

Parameters

TInt aExpiresParam

a "expires"-parameter value to set

SetRetryAfterParameterL(TInt)

IMPORT_C void

SetRetryAfterParameterL

(

TInt

aRetryAfterParam

)

Sets the "retry-after"-parameter

Pre-condition: aRetryAfterParam >= 0

Parameters

TInt aRetryAfterParam

a "retry-after"-parameter value to set

SetSubStateValueL(const TDesC8 &)

IMPORT_C void

SetSubStateValueL

(

const TDesC8 &

aSubStateValue

)

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

Parameters

const TDesC8 & aSubStateValue

a substate-value parameter to set

SubStateValue()

IMPORT_C const TDesC8 &

SubStateValue

(

)

const

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

ToTextMandatoryPartLC()

HBufC8 *

ToTextMandatoryPartLC

(

)

const [private, virtual]

Member Data Documentation

CSIPSubscriptionStateHeaderParams * iParams

CSIPSubscriptionStateHeaderParams *

iParams

[private]

HBufC8 * iSubStateValue

HBufC8 *

iSubStateValue

[private]