Class CSIPSubscriptionStateHeader

class CSIPSubscriptionStateHeader : public CSIPParameterHeaderBase;

Description

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

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"

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

Members

Defined in CSIPSubscriptionStateHeader:
CloneL(), DecodeL(), ExpiresParameter(), InternalizeValueL(), Name(), NewL(), NewLC(), RetryAfterParameter(), SetExpiresParameterL(), SetRetryAfterParameterL(), SetSubStateValueL(), SubStateValue(), ~CSIPSubscriptionStateHeader()

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 CSIPSubscriptionStateHeader *NewL(const TDesC8 &aSubStateValue);

Description

Creates a new instance of CSIPSubscriptionStateHeader

Parameters

const TDesC8 &aSubStateValue a substate-value value

Return value

CSIPSubscriptionStateHeader * a new instance of CSIPSubscriptionStateHeader

static IMPORT_C CSIPSubscriptionStateHeader *NewLC(const TDesC8 &aSubStateValue);

Description

Creates a new instance of CSIPSubscriptionStateHeader and puts it to CleanupStack

Parameters

const TDesC8 &aSubStateValue a substate-value value

Return value

CSIPSubscriptionStateHeader * a new instance of CSIPSubscriptionStateHeader

IMPORT_C ~CSIPSubscriptionStateHeader();

Description

Destructor, deletes the resources of CSIPSubscriptionStateHeader.

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

Description

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

Parameters

const TDesC8 &aValue a value part of a "Subscription-State"-header

Return value

CSIPSubscriptionStateHeader * a new instance of CSIPSubscriptionStateHeader

IMPORT_C const TDesC8 &SubStateValue() const;

Description

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

Return value

const TDesC8 & the substate-value parameter

IMPORT_C void SetSubStateValueL(const TDesC8 &aSubStateValue);

Description

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

Parameters

const TDesC8 &aSubStateValue a substate-value parameter to set

IMPORT_C TInt ExpiresParameter() const;

Description

Gets the value of the "expires"-parameter

Return value

TInt "expires"-parameter or KErrNotFound if not present

IMPORT_C void SetExpiresParameterL(TInt aExpiresParam);

Pre-Condition

aExpiresParam >= 0

Description

Sets the "expires"-parameter

Parameters

TInt aExpiresParam a "expires"-parameter value to set

IMPORT_C TInt RetryAfterParameter() const;

Description

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

Return value

TInt "retry-after"-parameter or KErrNotFound if not present

IMPORT_C void SetRetryAfterParameterL(TInt aRetryAfterParam);

Pre-Condition

aRetryAfterParam >= 0

Description

Sets the "retry-after"-parameter

Parameters

TInt aRetryAfterParam a "retry-after"-parameter value to set

static IMPORT_C CSIPHeaderBase *InternalizeValueL(RReadStream &aReadStream);

Description

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

Return value

CSIPHeaderBase * an instance of a CSIPSubscriptionStateHeader

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