Class CSIPRAckHeader

class CSIPRAckHeader : public CSIPHeaderBase;

Description

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

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

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

Members

Defined in CSIPRAckHeader:
CSeqNum(), CloneL(), DecodeL(), InternalizeValueL(), Method(), Name(), NewL(), NewLC(), Seq(), SetCSeqNum(), SetMethodL(), SetSeq(), ToTextValueL(), ~CSIPRAckHeader()

Inherited from CBase:
Delete(), Extension_(), operator new()

Inherited from CSIPHeaderBase:
ExternalizeL(), ExternalizeSupported(), PushLC(), ToTextL(), ToTextLC(), ToTextValueLC()

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

Description

Creates a new instance of CSIPRAckHeader

Parameters

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

Return value

CSIPRAckHeader * a new instance of CSIPRAckHeader

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

Description

Creates a new instance of CSIPRAckHeader and puts it to CleanupStack

Parameters

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

Return value

CSIPRAckHeader * a new instance of CSIPRAckHeader

IMPORT_C ~CSIPRAckHeader();

Description

Destructor, deletes the resources of CSIPRAckHeader.

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

Description

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

Parameters

const TDesC8 &aValue a value part of a "RAck"-header (e.g. "1 2 INVITE")

Return value

CSIPRAckHeader * a new instance of CSIPRAckHeader.

IMPORT_C TUint Seq() const;

Description

Gets the sequence number from the "RAck" header

Return value

TUint the current sequence number

IMPORT_C void SetSeq(TUint aSeq);

Description

Sets the sequence number in the "RAck" header

Parameters

TUint aSeq a sequence number to set

IMPORT_C TUint CSeqNum() const;

Description

Gets the sequence number from the "RAck" header

Return value

TUint the current sequence number

IMPORT_C void SetCSeqNum(TUint aCSeqNum);

Description

Sets the sequence number in the "RAck" header

Parameters

TUint aCSeqNum a sequence number to set

IMPORT_C RStringF Method() const;

Description

Gets the method from the "RAck" header

Return value

RStringF the method

IMPORT_C void SetMethodL(RStringF aMethod);

Description

Sets the method in the "RAck" header

Parameters

RStringF aMethod a method to set

static IMPORT_C CSIPHeaderBase *InternalizeValueL(RReadStream &aReadStream);

Description

Constructs an instance of a CSIPRAckHeader 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 CSIPRAckHeader

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

virtual IMPORT_C HBufC8 *ToTextValueL() const;

Description

From CSIPHeaderBase ToTextValueL

Return value

HBufC8 *