Class CSIPCSeqHeader

class CSIPCSeqHeader : public CSIPHeaderBase;

Description

Class provides functions for setting and getting sequence number and method in SIP "CSeq" 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

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

Members

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

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

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

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

Description

Creates a new instance of CSIPCSeqHeader

Parameters

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

Return value

CSIPCSeqHeader * a new instance of CSIPCSeqHeader

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

Description

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"

Return value

CSIPCSeqHeader * a new instance of CSIPCSeqHeader

IMPORT_C ~CSIPCSeqHeader();

Description

Destructor, deletes the resources of CSIPCSeqHeader.

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

Description

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

Return value

CSIPCSeqHeader * a new instance of CSIPCSeqHeader.

IMPORT_C TUint Seq() const;

Description

Gets the sequence number from the "CSeq" header

Return value

TUint the current sequence number

IMPORT_C void SetSeq(TUint aSeq);

Description

Sets the sequence number in the "CSeq" header

Parameters

TUint aSeq a sequence number to set

IMPORT_C RStringF Method() const;

Description

Gets the method from the "CSeq" header

Return value

RStringF the method

IMPORT_C void SetMethodL(RStringF aMethod);

Description

Sets the method in the "CSeq" header

Parameters

RStringF aMethod a method to set

static IMPORT_C CSIPHeaderBase *InternalizeValueL(RReadStream &aReadStream);

Description

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

Return value

CSIPHeaderBase * an instance of a CSIPCSeqHeader

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 *