Collapse all Symbian^3 Product Developer Library

CSIPCSeqHeader Class Reference

class CSIPCSeqHeader : public CSIPHeaderBase

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

sipcodec.lib

Inherits from

CSIPCSeqHeader
- CSIPHeaderBase
  - CBase

Public Member Functions
	~CSIPCSeqHeader()
RPointerArray< CSIPHeaderBase >	BaseDecodeL(const TDesC8 &)
IMPORT_C CSIPHeaderBase *	CloneL()
IMPORT_C CSIPCSeqHeader *	DecodeL(const TDesC8 &)
IMPORT_C CSIPHeaderBase *	InternalizeValueL(RReadStream &)
IMPORT_C RStringF	Method()
IMPORT_C RStringF	Name()
IMPORT_C CSIPCSeqHeader *	NewL(TUint, RStringF)
IMPORT_C CSIPCSeqHeader *	NewLC(TUint, RStringF)
TPreferredPlace	PreferredPlaceInMessage()
IMPORT_C TUint	Seq()
IMPORT_C void	SetMethodL(RStringF)
IMPORT_C void	SetSeq(TUint)
IMPORT_C HBufC8 *	ToTextValueL()

Private Member Functions
	CSIPCSeqHeader()
void	ConstructL(TUint, RStringF)
void	DoInternalizeValueL(RReadStream &)
void	ExternalizeValueL(RWriteStream &)
void	ParseL(const TDesC8 &)
void	SetMethodL(const TDesC8 &)

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

Inherited Enumerations
	CSIPHeaderBase:TPreferredPlace

Private Attributes
RStringF	iMethod
TUint	iSeq

Inherited Attributes
	CSIPHeaderBase::iLink

Constructor & Destructor Documentation

CSIPCSeqHeader()

CSIPCSeqHeader

(

)

[private]

~CSIPCSeqHeader()

IMPORT_C

~CSIPCSeqHeader

(

)

Destructor, deletes the resources of CSIPCSeqHeader.

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(TUint, RStringF)

void	ConstructL	(	TUint	aCSeq,
			RStringF	aMethod
		)	[private]

Parameters

TUint aCSeq
RStringF aMethod

DecodeL(const TDesC8 &)

IMPORT_C CSIPCSeqHeader *

DecodeL

(

const TDesC8 &

aValue

)

[static]

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

Parameters

const TDesC8 & aValue

a value part of a "CSeq"-header (e.g. "1 REGISTER")

DoInternalizeValueL(RReadStream &)

void

DoInternalizeValueL

(

RReadStream &

aReadStream

)

[private]

Parameters

RReadStream & aReadStream

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 CSIPCSeqHeader from a RReadStream

Parameters

RReadStream & aReadStream

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

Method()

IMPORT_C RStringF

Method

(

)

const

Gets the method from the "CSeq" header

Name()

IMPORT_C RStringF

Name

(

)

const [virtual]

From CSIPHeaderBase Name

NewL(TUint, RStringF)

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

Creates a new instance of CSIPCSeqHeader

Parameters

TUint aSeq	a sequence number to set.
RStringF aMethod	a method to set. For example "REGISTER"

NewLC(TUint, RStringF)

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

Creates a new instance of CSIPCSeqHeader and puts it to CleanupStack

Parameters

TUint aSeq	a sequence number to set.
RStringF aMethod	a method to set. For example "REGISTER"

ParseL(const TDesC8 &)

void

ParseL

(

const TDesC8 &

aValue

)

[private]

Parameters

const TDesC8 & aValue

PreferredPlaceInMessage()

TPreferredPlace

PreferredPlaceInMessage

(

)

const [virtual]

Seq()

IMPORT_C TUint

Seq

(

)

const

Gets the sequence number from the "CSeq" header

SetMethodL(RStringF)

IMPORT_C void

SetMethodL

(

RStringF

aMethod

)

Sets the method in the "CSeq" header

Parameters

RStringF aMethod

a method to set

SetMethodL(const TDesC8 &)

void

SetMethodL

(

const TDesC8 &

aMethod

)

[private]

Parameters

const TDesC8 & aMethod

SetSeq(TUint)

IMPORT_C void

SetSeq

(

TUint

aSeq

)

Sets the sequence number in the "CSeq" header

Parameters

TUint aSeq

a sequence number to set

ToTextValueL()

IMPORT_C HBufC8 *

ToTextValueL

(

)

const [virtual]

From CSIPHeaderBase ToTextValueL

Member Data Documentation

RStringF iMethod

RStringF

iMethod

[private]

TUint iSeq

TUint

iSeq

[private]