CSIPRequestElements Class Reference

#include <mw/siprequestelements.h>

Link against: sipclient.lib

class CSIPRequestElements : public CBase

Inherits from

Public Member Functions
~CSIPRequestElements()
IMPORT_C const CSIPCSeqHeader *CSeqHeader()
voidExternalizeL(RWriteStream &)
IMPORT_C const CSIPFromHeader *FromHeader()
CSIPRequestElements *InternalizeL(RReadStream &)
IMPORT_C const CSIPMessageElements &MessageElements()
IMPORT_C CSIPMessageElements &MessageElements()
IMPORT_C RStringFMethod()
IMPORT_C CSIPRequestElements *NewL(CUri8 *)
IMPORT_C CSIPRequestElements *NewLC(CUri8 *)
IMPORT_C const CUri8 &RemoteUri()
IMPORT_C voidSetFromHeaderL(CSIPFromHeader *)
IMPORT_C voidSetMethodL(RStringF)
IMPORT_C voidSetRemoteUriL(CUri8 *)
IMPORT_C voidSetToHeaderL(CSIPToHeader *)
IMPORT_C const CSIPToHeader *ToHeader()
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()

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

Constructor & Destructor Documentation

~CSIPRequestElements ( )

IMPORT_C~CSIPRequestElements()

Destructor.

Member Function Documentation

CSeqHeader ( )

IMPORT_C const CSIPCSeqHeader *CSeqHeader()const

Gets CSeq-header. Available for only incoming requests.

Return Value
a CSeq-header or a 0-pointer if not present. Ownership is not transferred.

ExternalizeL ( RWriteStream & )

voidExternalizeL(RWriteStream &aWriteStream)const

FromHeader ( )

IMPORT_C const CSIPFromHeader *FromHeader()const

Gets the originator's From-header

Return Value
From-header or a 0-pointer if not present. Ownership is not transferred.

InternalizeL ( RReadStream & )

CSIPRequestElements *InternalizeL(RReadStream &aReadStream)[static]

MessageElements ( )

IMPORT_C const CSIPMessageElements &MessageElements()const

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

Return Value
message elements

MessageElements ( )

IMPORT_C CSIPMessageElements &MessageElements()

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
message elements

Method ( )

IMPORT_C RStringFMethod()const

Gets the SIP Method for a request

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

NewL ( CUri8 * )

IMPORT_C CSIPRequestElements *NewL(CUri8 *aRemoteUri)[static]
Two-phased constructor. If the URI is SIP URI, no SIP URI headers are allowed.
Pre-condition
aRemoteURi != 0
Parameters
aRemoteUriRemote target URI that identifies a resource that the request is addressed to. The ownership is transferred.

NewLC ( CUri8 * )

IMPORT_C CSIPRequestElements *NewLC(CUri8 *aRemoteUri)[static]
Two-phased constructor. If the URI is SIP URI, no SIP URI headers are allowed.
Pre-condition
aRemoteURi != 0
Parameters
aRemoteUriRemote target URI that identifies a resource that the request is addressed to. The ownership is transferred.

RemoteUri ( )

IMPORT_C const CUri8 &RemoteUri()const

Gets the remote target URI

Return Value
remote target URI

SetFromHeaderL ( CSIPFromHeader * )

IMPORT_C voidSetFromHeaderL(CSIPFromHeader *aFrom)
Sets/resets the originator's From-header. From-header must not contain tag-parameter.
Pre-condition
aFrom != 0
Parameters
aFroma From-header to be set, the ownership is transferred.
Leave Codes
KErrArgumentif aFrom == 0

SetMethodL ( RStringF )

IMPORT_C voidSetMethodL(RStringFaMethod)
Sets the SIP request method
Parameters
aMethoda SIP method name.
Leave Codes
KErrArgumentif method name given is syntactically incorrect

SetRemoteUriL ( CUri8 * )

IMPORT_C voidSetRemoteUriL(CUri8 *aRemoteUri)
Sets the remote URI. If the URI is a SIP URI, no SIP URI headers are allowed.
Pre-condition
aRemoteUri != 0
Leave Codes
KErrArgumentif aRemoteUri==0

SetToHeaderL ( CSIPToHeader * )

IMPORT_C voidSetToHeaderL(CSIPToHeader *aTo)
Sets/resets the recipient's To-header To-header must not contain tag-parameter.
Pre-condition
aTo != 0
Parameters
aToa To-header to be set, the ownership is transferred.

ToHeader ( )

IMPORT_C const CSIPToHeader *ToHeader()const

Gets the recipient's To-header

Return Value
To-header or a 0-pointer if not present. Ownership is not transferred.
© Nokia 2011.