CSIPRAckHeader Class Reference

#include <mw/siprackheader.h>

Link against: sipcodec.lib

class CSIPRAckHeader : public CSIPHeaderBase

Inherits from

CSIPRAckHeader
- CSIPHeaderBase

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

Inherited Attributes
	CSIPHeaderBase::iLink

Inherited Enumerations
	CSIPHeaderBase:TPreferredPlace

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

Detailed Description

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

Constructor & Destructor Documentation

~CSIPRAckHeader ( )

IMPORT_C

~CSIPRAckHeader

(

)

Destructor, deletes the resources of CSIPRAckHeader.

Member Function Documentation

BaseDecodeL ( const TDesC8 & )

RPointerArray< CSIPHeaderBase >

BaseDecodeL

(

const TDesC8 &

aValue

)

[static]

CSeqNum ( )

IMPORT_C TUint

CSeqNum

(

)

const

Gets the sequence number from the "RAck" header

Returns: the current sequence number

CloneL ( )

IMPORT_C CSIPHeaderBase *

CloneL

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::CloneL()const

From CSIPHeaderBase CloneL

DecodeL ( const TDesC8 & )

IMPORT_C CSIPRAckHeader *

DecodeL

(

const TDesC8 &

aValue

)

[static]

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

Parameter	Description
aValue	a value part of a "RAck"-header (e.g. "1 2 INVITE")

Returns: a new instance of CSIPRAckHeader.

InternalizeValueL ( RReadStream & )

IMPORT_C CSIPHeaderBase *

InternalizeValueL

(

RReadStream &

aReadStream

)

[static]

Constructs an instance of a CSIPRAckHeader from a RReadStream

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

Returns: an instance of a CSIPRAckHeader

Method ( )

IMPORT_C RStringF

Method

(

)

const

Gets the method from the "RAck" header

Returns: the method

Name ( )

IMPORT_C RStringF

Name

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::Name()const

From CSIPHeaderBase Name

NewL ( TUint, TUint, RStringF )

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

Creates a new instance of CSIPRAckHeader

Parameter	Description
aSeq	a sequence number to set
aCSeqNum	a sequence number from CSeq-header
aMethod	a method to set. For example "REGISTER"

Returns: a new instance of CSIPRAckHeader

NewLC ( TUint, TUint, RStringF )

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

Creates a new instance of CSIPRAckHeader and puts it to CleanupStack

Parameter	Description
aSeq	a sequence number to set
aCSeqNum	a sequence number from CSeq-header
aMethod	a method to set. For example "REGISTER"

Returns: a new instance of CSIPRAckHeader

PreferredPlaceInMessage ( )

TPreferredPlace

PreferredPlaceInMessage

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::PreferredPlaceInMessage()const

Seq ( )

IMPORT_C TUint

Seq

(

)

const

Gets the sequence number from the "RAck" header

Returns: the current sequence number

SetCSeqNum ( TUint )

IMPORT_C void

SetCSeqNum

(

TUint

aCSeqNum

)

Sets the sequence number in the "RAck" header

Parameter	Description
aCSeqNum	a sequence number to set

SetMethodL ( RStringF )

IMPORT_C void

SetMethodL

(

RStringF

aMethod

)

Sets the method in the "RAck" header

Parameter	Description
aMethod	a method to set

SetSeq ( TUint )

IMPORT_C void

SetSeq

(

TUint

aSeq

)

Sets the sequence number in the "RAck" header

Parameter	Description
aSeq	a sequence number to set

ToTextValueL ( )

IMPORT_C HBufC8 *

ToTextValueL

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::ToTextValueL()const

From CSIPHeaderBase ToTextValueL