Symbian^3 Application Developer Library >

CSIPRequestElements Class Reference

class CSIPRequestElements : public CBase

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

Inherits from

Public Member Functions
~CSIPRequestElements ()
IMPORT_C const CSIPCSeqHeader * CSeqHeader ()
void ExternalizeL ( RWriteStream &)
IMPORT_C const CSIPFromHeader * FromHeader ()
CSIPRequestElements * InternalizeL ( RReadStream &)
IMPORT_C const CSIPMessageElements & MessageElements ()
IMPORT_C CSIPMessageElements & MessageElements ()
IMPORT_C RStringF Method ()
IMPORT_C CSIPRequestElements * NewL ( CUri8 *)
IMPORT_C CSIPRequestElements * NewLC ( CUri8 *)
IMPORT_C const CUri8 & RemoteUri ()
IMPORT_C void SetFromHeaderL ( CSIPFromHeader *)
IMPORT_C void SetMethodL ( RStringF )
IMPORT_C void SetRemoteUriL ( CUri8 *)
IMPORT_C void SetToHeaderL ( CSIPToHeader *)
IMPORT_C const CSIPToHeader * ToHeader ()
Private Member Functions
CSIPRequestElements ()
void ConstructL ( CUri8 *)
void DoInternalizeL ( RReadStream &)
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()
Private Attributes
CSIPMessageElements * iMessageElements
RStringF iMethod
CURIContainer * iRemoteURI

Constructor & Destructor Documentation

CSIPRequestElements()

CSIPRequestElements ( ) [private]

~CSIPRequestElements()

IMPORT_C ~CSIPRequestElements ( )

Destructor.

Member Functions Documentation

CSeqHeader()

IMPORT_C const CSIPCSeqHeader * CSeqHeader ( ) const

Gets CSeq-header. Available for only incoming requests.

ConstructL(CUri8 *)

void ConstructL ( CUri8 * aRemoteUri ) [private]

Parameters

CUri8 * aRemoteUri

DoInternalizeL(RReadStream &)

void DoInternalizeL ( RReadStream & aReadStream ) [private]

Parameters

RReadStream & aReadStream

ExternalizeL(RWriteStream &)

void ExternalizeL ( RWriteStream & aWriteStream ) const

Parameters

RWriteStream & aWriteStream

FromHeader()

IMPORT_C const CSIPFromHeader * FromHeader ( ) const

Gets the originator's From-header

InternalizeL(RReadStream &)

CSIPRequestElements * InternalizeL ( RReadStream & aReadStream ) [static]

Parameters

RReadStream & aReadStream

MessageElements()

IMPORT_C const CSIPMessageElements & MessageElements ( ) const

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

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.

Method()

IMPORT_C RStringF Method ( ) const

Gets the SIP Method for a request

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

CUri8 * aRemoteUri Remote 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

CUri8 * aRemoteUri Remote 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

SetFromHeaderL(CSIPFromHeader *)

IMPORT_C void SetFromHeaderL ( CSIPFromHeader * aFrom )
Sets/resets the originator's From-header. From-header must not contain tag-parameter.
Pre-condition
aFrom != 0
leave
KErrArgument if aFrom == 0

Parameters

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

SetMethodL(RStringF)

IMPORT_C void SetMethodL ( RStringF aMethod )
Sets the SIP request method
leave
KErrArgument if method name given is syntactically incorrect

Parameters

RStringF aMethod a SIP method name.

SetRemoteUriL(CUri8 *)

IMPORT_C void SetRemoteUriL ( CUri8 * aRemoteUri )
Sets the remote URI. If the URI is a SIP URI, no SIP URI headers are allowed.
Pre-condition
aRemoteUri != 0
leave
KErrArgument if aRemoteUri==0

Parameters

CUri8 * aRemoteUri

SetToHeaderL(CSIPToHeader *)

IMPORT_C void SetToHeaderL ( CSIPToHeader * aTo )
Sets/resets the recipient's To-header To-header must not contain tag-parameter.
Pre-condition
aTo != 0

Parameters

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

ToHeader()

IMPORT_C const CSIPToHeader * ToHeader ( ) const

Gets the recipient's To-header

Member Data Documentation

CSIPMessageElements * iMessageElements

CSIPMessageElements * iMessageElements [private]

RStringF iMethod

RStringF iMethod [private]

CURIContainer * iRemoteURI

CURIContainer * iRemoteURI [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.