Collapse all Symbian^3 Product Developer Library

CSIPClient Class Reference

class CSIPClient : public CBase

This class is used to communicate with the SIP server Class provides functions for sending and receiving SIP requests and SIP responses. This class also provides functions for creating and destroying SIP dialogs, sending and receiving SIP requests and responses within SIP dialogs, canceling the SIP requests.

This class can only be created once by an application (a singleton class)

If the preconditions or postconditions are not met the function call will result in panics.

For SIP specific error codes TError

Inherits from

CSIPClient
- CBase

Public Member Functions
	~CSIPClient()
void	AddL(CSIPClientConnection *)
CSIPClientConnection *	Connection(TUint32)
TInt	IgnoreChallenge(TUint32, TUint32, const TDesC8 &)
TBool	IsSigCompSupportedL()
HBufC8 *	NegotiatedSecurityMechanismL(const TDesC8 &)
CSIPClient *	NewL(const TUid &, MSIPClientObserver &)
CSIPClient *	NewLC(const TUid &, MSIPClientObserver &)
TInt	Remove(const CSIPClientConnection *)
TInt	RemoveCredentials(const TDesC8 &)
void	RemoveHttpDigestObserver()
RSIP &	SIP()
void	SetCredentialsL(TUint32, TUint32, const TDesC8 &, const TDesC8 &, const TDesC8 &, const TDesC8 &)
TInt	SetHttpDigestObserver(MSIPHttpDigestChallengeObserver &)
TInt	SetHttpDigestObserver(MSIPHttpDigestChallengeObserver2 &)
void	SetSecurityHandlingL(TBool)
CDesC8Array *	SupportedSecurityMechanismsL()

Private Member Functions
	CSIPClient()
void	ConstructL(const TUid &, MSIPClientObserver &)
TInt	FindIndex(TUint32)
TInt	SendHttpDigestObserverTypeToServer(const TSipHttpDigestObserverType &)

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

Public Member Enumerations
enum	TError { ENonExistingRequestId = 10, ENonExistingDialogId, ENonExistingRefreshId, ENonExistingRegistrationId }

Private Attributes
RPointerArray< CSIPClientConnection >	iConnections
CSIPClientReceiver *	iReceiver
RSIP *	iSip

Constructor & Destructor Documentation

CSIPClient()

CSIPClient

(

)

[private]

~CSIPClient()

~CSIPClient

(

)

Destructor

Member Functions Documentation

AddL(CSIPClientConnection *)

void

AddL

(

CSIPClientConnection *

aConnection

)

Parameters

CSIPClientConnection * aConnection

Connection(TUint32)

CSIPClientConnection *

Connection

(

TUint32

aIapId

)

const

Checks if the user has a connection created for given IAP-id

Parameters

TUint32 aIapId

IAP-id

ConstructL(const TUid &, MSIPClientObserver &)

void	ConstructL	(	const TUid &	aUid,
			MSIPClientObserver &	aObserver
		)	[private]

Parameters

const TUid & aUid
MSIPClientObserver & aObserver

FindIndex(TUint32)

TInt

FindIndex

(

TUint32

aIapId

)

const [private]

Parameters

TUint32 aIapId

IgnoreChallenge(TUint32, TUint32, const TDesC8 &)

TInt	IgnoreChallenge	(	TUint32	aRequestId,
			TUint32	aRefreshId,
			const TDesC8 &	aRealm
		)

Ignores the challenge for the realm. As a result the error will be generated to the original request.

Parameters

TUint32 aRequestId	request id if needed, otherwise zero
TUint32 aRefreshId	refresh id if needed, otherwise zero
const TDesC8 & aRealm	a realm for which the challenge was ignored

IsSigCompSupportedL()

TBool

IsSigCompSupportedL

(

)

const

Checks if the signalling compression (SigComp) is supported. Leaves on failure with a system wide error code.

NegotiatedSecurityMechanismL(const TDesC8 &)

HBufC8 *

NegotiatedSecurityMechanismL

(

const TDesC8 &

aHop

)

Gets negotiated security mechanism with the next hop on the signaling path.

Parameters

const TDesC8 & aHop

the next hop's FQDN or numeric IP address

NewL(const TUid &, MSIPClientObserver &)

CSIPClient *	NewL	(	const TUid &	aUid,
			MSIPClientObserver &	aSIPObserver
		)	[static]

Constructs an object; leaves on failure.

Parameters

const TUid & aUid	an unique id that identifies an application
MSIPClientObserver & aSIPObserver	a sip observer. This callback is used for passing SIP requests and internal errors to application.

NewLC(const TUid &, MSIPClientObserver &)

CSIPClient *	NewLC	(	const TUid &	aUid,
			MSIPClientObserver &	aSIPObserver
		)	[static]

Constructs an object and adds the pointer to the cleanup stack;

Parameters

const TUid & aUid	an unique id that identifies an application
MSIPClientObserver & aSIPObserver	a sip observer. This callback is used for passing SIP requests and internal errors to application.

Remove(const CSIPClientConnection *)

TInt

Remove

(

const CSIPClientConnection *

aConnection

)

Parameters

const CSIPClientConnection * aConnection

RemoveCredentials(const TDesC8 &)

TInt

RemoveCredentials

(

const TDesC8 &

aRealm

)

Removes all set credentials for the realm

Parameters

const TDesC8 & aRealm

servers's realm. If set to KNullDesC8 clears all the credentials for this CSIPClient.

RemoveHttpDigestObserver()

void

RemoveHttpDigestObserver

(

)

Removes the observer that listens for the possible received challenges.

SIP()

RSIP &

SIP

(

)

SendHttpDigestObserverTypeToServer(const TSipHttpDigestObserverType &)

TInt

SendHttpDigestObserverTypeToServer

(

const TSipHttpDigestObserverType &

aObserverType

)

[private]

Parameters

const TSipHttpDigestObserverType & aObserverType

SetCredentialsL(TUint32, TUint32, const TDesC8 &, const TDesC8 &, const TDesC8 &, const TDesC8 &)

void	SetCredentialsL	(	TUint32	aRequestId,
			TUint32	aRefreshId,
			const TDesC8 &	aRealm,
			const TDesC8 &	aUsername,
			const TDesC8 &	aPasswd,
			const TDesC8 &	aOutboundProxy
		)

Sets credentials for a realm.

leave: KErrNoMemory if out of memory

Parameters

TUint32 aRequestId	request id if needed, otherwise zero
TUint32 aRefreshId	refresh id if needed, otherwise zero
const TDesC8 & aRealm	servers's realm
const TDesC8 & aUsername	user's name
const TDesC8 & aPasswd	user's password for the given server's realm
const TDesC8 & aOutboundProxy	an outbound proxy (FQDN or IP address) Must be set to KNullDesC8 if not used.

SetHttpDigestObserver(MSIPHttpDigestChallengeObserver &)

TInt

SetHttpDigestObserver

(

MSIPHttpDigestChallengeObserver &

aObserver

)

Sets the observer to listen for the possible received challenges.

Parameters

MSIPHttpDigestChallengeObserver & aObserver

an observer for the received challenges.

SetHttpDigestObserver(MSIPHttpDigestChallengeObserver2 &)

TInt

SetHttpDigestObserver

(

MSIPHttpDigestChallengeObserver2 &

aObserver

)

Sets the observer to listen for the possible received challenges.

Parameters

MSIPHttpDigestChallengeObserver2 & aObserver

an observer for the received challenges.

SetSecurityHandlingL(TBool)

void

SetSecurityHandlingL

(

TBool

aEnabled

)

Parameters

TBool aEnabled

SupportedSecurityMechanismsL()

CDesC8Array *

SupportedSecurityMechanismsL

(

)

const

Gets the names of all the supported security mechanisms

Member Enumerations Documentation

Enum TError

SIP specific errors

Enumerators

ENonExistingRequestId = 10	Non-existing request Id provided
ENonExistingDialogId	Non-existing dialog Id provided
ENonExistingRefreshId	Non-existing refresh Id provided
ENonExistingRegistrationId	Non-existing registration Id provided

Member Data Documentation

RPointerArray< CSIPClientConnection > iConnections

RPointerArray< CSIPClientConnection >

iConnections

[private]

CSIPClientReceiver * iReceiver

CSIPClientReceiver *

iReceiver

[private]

RSIP * iSip

RSIP *

iSip

[private]