S60 3rd Edition API Reference: CSIPRetryAfterHeader Class Reference

CSIPRetryAfterHeader Class Reference

API published in: S60 3rd Ed

Link against: sipcodec.lib

Capability Information

Required Capabilities

None

#include <sipretryafterheader.h>

Inherits CSIPParameterHeaderBase.

Detailed Description

PublishedAll
Released
Class provides functions for setting and getting parameters in SIP "Retry-After" header.

Public Member Functions

virtual IMPORT_C ~CSIPRetryAfterHeader ()
 Destructor, deletes the resources of CSIPRetryAfterHeader.
IMPORT_C void SetRetryAfter (TUint aValue)
 Sets the retry after value.
IMPORT_C TUint RetryAfter () const
 Gets the retry after value.
IMPORT_C const TDesC8 & Comment () const
 Gets the comment value.
IMPORT_C TInt DurationParam () const
 Gets the value of the "duration"-parameter.
IMPORT_C void SetDurationParamL (TInt aDurationParam)
 Sets the "duration"-parameter.
IMPORT_C CSIPHeaderBase * CloneL () const
 From CSIPHeaderBase CloneL.
IMPORT_C RStringF Name () const
 From CSIPHeaderBase Name.
TPreferredPlace PreferredPlaceInMessage () const

Static Public Member Functions

static IMPORT_C CSIPRetryAfterHeader * DecodeL (const TDesC8 &aValue)
 Constructs a CSIPRetryAfterHeader from textual representation of the header's value part.
static IMPORT_C CSIPRetryAfterHeader * NewL (TUint aRetryAfter)
 Creates a new instance of CSIPRetryAfterHeader.
static IMPORT_C CSIPRetryAfterHeader * NewLC (TUint aRetryAfter)
 Creates a new instance of CSIPRetryAfterHeader On return the new instance has left to the CleanupStack.
static IMPORT_C CSIPHeaderBase * InternalizeValueL (RReadStream &aReadStream)
 Constructs an instance of a CSIPRetryAfterHeader from a RReadStream.
static RPointerArray< CSIPHeaderBase > BaseDecodeL (const TDesC8 &aValue)

Constructor & Destructor Documentation

virtual IMPORT_C CSIPRetryAfterHeader::~CSIPRetryAfterHeader (   )  [virtual]
 

Destructor, deletes the resources of CSIPRetryAfterHeader.

Member Function Documentation

static RPointerArray<CSIPHeaderBase> CSIPRetryAfterHeader::BaseDecodeL ( const TDesC8 &  aValue  )  [static]
 
IMPORT_C CSIPHeaderBase* CSIPRetryAfterHeader::CloneL (   )  const [virtual]
 

From CSIPHeaderBase CloneL.

Implements CSIPHeaderBase.

IMPORT_C const TDesC8& CSIPRetryAfterHeader::Comment (   )  const
 

Gets the comment value.

Returns:
a comment value or KNullDesC8
static IMPORT_C CSIPRetryAfterHeader* 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")
Returns:
a new instance of CSIPRetryAfterHeader
IMPORT_C TInt CSIPRetryAfterHeader::DurationParam (   )  const
 

Gets the value of the "duration"-parameter.

Returns:
the "duration"-parameter, or KErrNotFound if the parameter is not present.
static IMPORT_C CSIPHeaderBase* CSIPRetryAfterHeader::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).
Returns:
an instance of a CSIPRetryAfterHeader
IMPORT_C RStringF CSIPRetryAfterHeader::Name (   )  const [virtual]
 

From CSIPHeaderBase Name.

Implements CSIPHeaderBase.

static IMPORT_C CSIPRetryAfterHeader* CSIPRetryAfterHeader::NewL ( TUint  aRetryAfter  )  [static]
 

Creates a new instance of CSIPRetryAfterHeader.

Parameters:
aRetryAfter a retry after value.
Returns:
a new instance of CSIPRetryAfterHeader
static IMPORT_C CSIPRetryAfterHeader* 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.
Returns:
a new instance of CSIPRetryAfterHeader
TPreferredPlace CSIPRetryAfterHeader::PreferredPlaceInMessage (   )  const [virtual]
 

Implements CSIPHeaderBase.

IMPORT_C TUint CSIPRetryAfterHeader::RetryAfter (   )  const
 

Gets the retry after value.

Returns:
a retry after value
IMPORT_C void CSIPRetryAfterHeader::SetDurationParamL ( TInt  aDurationParam  ) 
 

Sets the "duration"-parameter.

Precondition:
aDurationParam >= 0
Parameters:
aDurationParam a "duration"-parameter value to set
IMPORT_C void CSIPRetryAfterHeader::SetRetryAfter ( TUint  aValue  ) 
 

Sets the retry after value.

Parameters:
aValue a new retry after value to set.
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top