S60 3rd Edition API Reference: CSIPCSeqHeader Class Reference

CSIPCSeqHeader Class Reference

API published in: S60 2nd Ed

Link against: sipcodec.lib

Capability Information

Required Capabilities

None

#include <sipcseqheader.h>

Inherits CSIPHeaderBase.

Detailed Description

PublishedAll
Released
Class provides functions for setting and getting sequence number and method in SIP "CSeq" header.

Public Member Functions

IMPORT_C ~CSIPCSeqHeader ()
 Destructor, deletes the resources of CSIPCSeqHeader.
IMPORT_C TUint Seq () const
 Gets the sequence number from the "CSeq" header.
IMPORT_C void SetSeq (TUint aSeq)
 Sets the sequence number in the "CSeq" header.
IMPORT_C RStringF Method () const
 Gets the method from the "CSeq" header.
IMPORT_C void SetMethodL (RStringF aMethod)
 Sets the method in the "CSeq" header.
IMPORT_C CSIPHeaderBase * CloneL () const
 From CSIPHeaderBase CloneL.
IMPORT_C RStringF Name () const
 From CSIPHeaderBase Name.
IMPORT_C HBufC8 * ToTextValueL () const
 From CSIPHeaderBase ToTextValueL.
TPreferredPlace PreferredPlaceInMessage () const

Static Public Member Functions

static IMPORT_C CSIPCSeqHeader * DecodeL (const TDesC8 &aValue)
 Constructs a CSIPCSeqHeader from textual representation of the header's value part.
static IMPORT_C CSIPCSeqHeader * NewL (TUint aSeq, RStringF aMethod)
 Creates a new instance of CSIPCSeqHeader.
static IMPORT_C CSIPCSeqHeader * NewLC (TUint aSeq, RStringF aMethod)
 Creates a new instance of CSIPCSeqHeader and puts it to CleanupStack.
static IMPORT_C CSIPHeaderBase * InternalizeValueL (RReadStream &aReadStream)
 Constructs an instance of a CSIPCSeqHeader from a RReadStream.
static RPointerArray< CSIPHeaderBase > BaseDecodeL (const TDesC8 &aValue)

Constructor & Destructor Documentation

IMPORT_C CSIPCSeqHeader::~CSIPCSeqHeader (   ) 
 

Destructor, deletes the resources of CSIPCSeqHeader.

Member Function Documentation

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

From CSIPHeaderBase CloneL.

Implements CSIPHeaderBase.

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

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

Parameters:
aValue a value part of a "CSeq"-header (e.g. "1 REGISTER")
Returns:
a new instance of CSIPCSeqHeader.
static IMPORT_C CSIPHeaderBase* CSIPCSeqHeader::InternalizeValueL ( RReadStream &  aReadStream  )  [static]
 

Constructs an instance of a CSIPCSeqHeader from a RReadStream.

Parameters:
aReadStream a stream containing the value of the externalized object (header name not included).
Returns:
an instance of a CSIPCSeqHeader
IMPORT_C RStringF CSIPCSeqHeader::Method (   )  const
 

Gets the method from the "CSeq" header.

Returns:
the method
IMPORT_C RStringF CSIPCSeqHeader::Name (   )  const [virtual]
 

From CSIPHeaderBase Name.

Implements CSIPHeaderBase.

static IMPORT_C CSIPCSeqHeader* CSIPCSeqHeader::NewL ( TUint  aSeq,
RStringF  aMethod
)  [static]
 

Creates a new instance of CSIPCSeqHeader.

Parameters:
aSeq a sequence number to set.
aMethod a method to set. For example "REGISTER"
Returns:
a new instance of CSIPCSeqHeader
static IMPORT_C CSIPCSeqHeader* CSIPCSeqHeader::NewLC ( TUint  aSeq,
RStringF  aMethod
)  [static]
 

Creates a new instance of CSIPCSeqHeader and puts it to CleanupStack.

Parameters:
aSeq a sequence number to set.
aMethod a method to set. For example "REGISTER"
Returns:
a new instance of CSIPCSeqHeader
TPreferredPlace CSIPCSeqHeader::PreferredPlaceInMessage (   )  const [virtual]
 

Implements CSIPHeaderBase.

IMPORT_C TUint CSIPCSeqHeader::Seq (   )  const
 

Gets the sequence number from the "CSeq" header.

Returns:
the current sequence number
IMPORT_C void CSIPCSeqHeader::SetMethodL ( RStringF  aMethod  ) 
 

Sets the method in the "CSeq" header.

Parameters:
aMethod a method to set
IMPORT_C void CSIPCSeqHeader::SetSeq ( TUint  aSeq  ) 
 

Sets the sequence number in the "CSeq" header.

Parameters:
aSeq a sequence number to set
IMPORT_C HBufC8* CSIPCSeqHeader::ToTextValueL (   )  const [virtual]
 

From CSIPHeaderBase ToTextValueL.

Implements CSIPHeaderBase.

The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top