Class CSIPResponseElements

class CSIPResponseElements : public CBase;

Description

Class provides services for creating and manipulating SIP responses This class is used for creating and manipulating SIP responses including status code, reason phrase and optional elements such user headers, content and its type.

sipclient.lib

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CSIPResponseElements - Class provides services for creating and manipulating SIP responses This class is used for creating and manipulating SIP responses including status code, reason phrase and optional elements such user headers, content and its type

Members

Defined in CSIPResponseElements:
CSeqHeader(), FromHeader(), MessageElements(), MessageElements(), NewL(), NewLC(), ReasonPhrase(), SetReasonPhraseL(), SetStatusCodeL(), StatusCode(), ToHeader(), ~CSIPResponseElements()

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

static IMPORT_C CSIPResponseElements *NewL(TUint aStatusCode, RStringF aReasonPhrase);

Pre-Condition

aStatusCode > 100 && aStatusCode < 700

Description

Two-phased constructor.

Parameters

TUint aStatusCode a known SIP response status code. Cannot be 100. RStringF aReasonPhrase a SIP response reason phrase.

Return value

CSIPResponseElements *

static IMPORT_C CSIPResponseElements *NewLC(TUint aStatusCode, RStringF aReasonPhrase);

Pre-Condition

aStatusCode > 100 && aStatusCode < 700

Description

Two-phased constructor.

Parameters

TUint aStatusCode a known SIP response status code. Cannot be 100. RStringF aReasonPhrase a SIP response reason phrase.

Return value

CSIPResponseElements *

IMPORT_C ~CSIPResponseElements();

Description

Destructor.

IMPORT_C void SetStatusCodeL(TUint aStatusCode);

Pre-Condition

aStatusCode > 100 && aStatusCode < 700

Description

Sets a SIP Response extension status code. It is not possible to set value 100.

Parameters

TUint aStatusCode extension status code

Leave codes

KErrArgument if aStatusCode < 100 or aStatusCode >= 700

IMPORT_C TUint StatusCode() const;

Description

Gets the SIP Response status code

Return value

TUint SIP Response status code

IMPORT_C void SetReasonPhraseL(RStringF aReasonPhrase);

Description

Sets a SIP Response Reason Phrase.

Parameters

RStringF aReasonPhrase a SIP response reason phrase.

IMPORT_C RStringF ReasonPhrase() const;

Description

Gets a SIP Response Reason Phrase.

Return value

RStringF a SIP response reason phrase or an empty string if the reason phrase is not defined.

IMPORT_C const CSIPFromHeader *FromHeader() const;

Description

Gets the originator's From-header

Return value

const CSIPFromHeader * a From-header or a 0-pointer if not present. Ownership is not transferred.

IMPORT_C const CSIPToHeader *ToHeader() const;

Description

Gets the recipient's To-header

Return value

const CSIPToHeader * a To-header or a 0-pointer if not present. Ownership is not transferred.

IMPORT_C const CSIPCSeqHeader *CSeqHeader() const;

Description

Gets CSeq-header

Return value

const CSIPCSeqHeader * a CSeq-header or a 0-pointer if not present. Ownership is not transferred.

IMPORT_C const CSIPMessageElements &MessageElements() const;

Description

Gets message elements (contains all SIP user headers and content)

Return value

const CSIPMessageElements & message elements

IMPORT_C CSIPMessageElements &MessageElements();

Description

Gets message elements (contains all SIP user headers and content) The response elements can be populated with SIP user headers and content using returned reference to the message elements.

Return value

CSIPMessageElements & message elements