Class CSIPRequestElements

class CSIPRequestElements : public CBase;

Description

Class provides functions for creation and manipulation of originator's and recipient's addresses in a SIP request. It also provide functions for manipulation of SIP method for unknown SIP requests. sipclient.lib

Derivation

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

• CSIPRequestElements - Class provides functions for creation and manipulation of originator's and recipient's addresses in a SIP request

Members

Defined in CSIPRequestElements:
CSeqHeader(), FromHeader(), MessageElements(), MessageElements(), Method(), NewL(), NewLC(), RemoteUri(), SetFromHeaderL(), SetMethodL(), SetRemoteUriL(), SetToHeaderL(), ToHeader(), ~CSIPRequestElements()

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

static IMPORT_C CSIPRequestElements *NewL(CUri8 *aRemoteUri);

Pre-Condition

aRemoteURi != 0

Description

Two-phased constructor. If the URI is SIP URI, no SIP URI headers are allowed.

Parameters

CUri8 *aRemoteUri Remote target URI that identifies a resource that the request is addressed to. The ownership is transferred.

Return value

CSIPRequestElements *

static IMPORT_C CSIPRequestElements *NewLC(CUri8 *aRemoteUri);

Pre-Condition

aRemoteURi != 0

Description

Two-phased constructor. If the URI is SIP URI, no SIP URI headers are allowed.

Parameters

CUri8 *aRemoteUri Remote target URI that identifies a resource that the request is addressed to. The ownership is transferred.

Return value

CSIPRequestElements *

IMPORT_C ~CSIPRequestElements();

Description

Destructor.

IMPORT_C void SetToHeaderL(CSIPToHeader *aTo);

Pre-Condition

aTo != 0

Description

Sets/resets the recipient's To-header To-header must not contain tag-parameter.

Parameters

CSIPToHeader *aTo a To-header to be set, the ownership is transferred.

IMPORT_C const CSIPToHeader *ToHeader() const;

Description

Gets the recipient's To-header

Return value

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

IMPORT_C void SetFromHeaderL(CSIPFromHeader *aFrom);

Pre-Condition

aFrom != 0

Description

Sets/resets the originator's From-header. From-header must not contain tag-parameter.

Parameters

CSIPFromHeader *aFrom a From-header to be set, the ownership is transferred.

Leave codes

KErrArgument if aFrom == 0

IMPORT_C const CSIPFromHeader *FromHeader() const;

Description

Gets the originator's From-header

Return value

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

IMPORT_C const CSIPCSeqHeader *CSeqHeader() const;

Description

Gets CSeq-header. Available for only incoming requests.

Return value

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

IMPORT_C void SetRemoteUriL(CUri8 *aRemoteUri);

Pre-Condition

aRemoteUri != 0

Description

Sets the remote URI. If the URI is a SIP URI, no SIP URI headers are allowed.

Parameters

CUri8 *aRemoteUri

Leave codes

KErrArgument if aRemoteUri==0

IMPORT_C const CUri8 &RemoteUri() const;

Description

Gets the remote target URI

Return value

const CUri8 & remote target URI

IMPORT_C void SetMethodL(RStringF aMethod);

Description

Sets the SIP request method

Parameters

RStringF aMethod a SIP method name.

Leave codes

KErrArgument if method name given is syntactically incorrect

IMPORT_C RStringF Method() const;

Description

Gets the SIP Method for a request

Return value

RStringF a SIP method name or a an empty string if the method is not defined

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