Collapse all Symbian^3 Product Developer Library

CSIP Class Reference

class CSIP : public CBase

Class for connecting to SIP server.

This class provides the connection to the SIP server and provides functions for quering supported SIP security mechanisms and the support of signalling compression (SigComp).

Note that the implementation uses strings defined in the SIP Codec string pool. During instantiation the class will open SIP codec string pool for getting static strings and getting and setting dynamic strings.

The user can create only one instance of this class. (a singleton class).

sipclient.lib

Inherits from

CSIP
- CBase

Public Member Functions
	~CSIP()
IMPORT_C CSIPConnection *	Connection(TUint32)
CSIPImplementation &	Implementation()
IMPORT_C TBool	IsSecurityHandlingEnabled()
IMPORT_C TBool	IsSigCompSupportedL()
IMPORT_C HBufC8 *	NegotiatedSecurityMechanismL(const TDesC8 &)
IMPORT_C CSIP *	NewL(const TUid &, MSIPObserver &)
IMPORT_C CSIP *	NewLC(const TUid &, MSIPObserver &)
IMPORT_C void	SetSecurityHandlingL(TBool)
IMPORT_C CDesC8Array *	SupportedSecurityMechanismsL()

Private Member Functions
	CSIP()
void	ConstructL(const TUid &, MSIPObserver &)
void	__DbgTestInvariant()

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
CSIPImplementation *	iImplementation

Constructor & Destructor Documentation

CSIP()

CSIP

(

)

[private]

~CSIP()

IMPORT_C

~CSIP

(

)

Destructor.

Member Functions Documentation

Connection(TUint32)

IMPORT_C CSIPConnection *

Connection

(

TUint32

aIapId

)

const

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

Parameters

TUint32 aIapId

IAP-id

ConstructL(const TUid &, MSIPObserver &)

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

Parameters

const TUid & aUid
MSIPObserver & aObserver

Implementation()

CSIPImplementation &

Implementation

(

)

Returns the CSIPImplementation.

IsSecurityHandlingEnabled()

IMPORT_C TBool

IsSecurityHandlingEnabled

(

)

const

IsSigCompSupportedL()

IMPORT_C TBool

IsSigCompSupportedL

(

)

const

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

NegotiatedSecurityMechanismL(const TDesC8 &)

IMPORT_C 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 &, MSIPObserver &)

IMPORT_C CSIP *	NewL	(	const TUid &	aUid,
			MSIPObserver &	aObserver
		)	[static]

Two-phased constructor.

capability: WriteDeviceData

Parameters

const TUid & aUid	an unique id that identifies client
MSIPObserver & aObserver	a observer for asynchronous event

NewLC(const TUid &, MSIPObserver &)

IMPORT_C CSIP *	NewLC	(	const TUid &	aUid,
			MSIPObserver &	aObserver
		)	[static]

Two-phased constructor. Constructs an object and adds the pointer to the cleanup stack.

capability: WriteDeviceData

Parameters

const TUid & aUid	an unique id that identifies client
MSIPObserver & aObserver	a observer for asynchronous event

SetSecurityHandlingL(TBool)

IMPORT_C void

SetSecurityHandlingL

(

TBool

aEnabled

)

Parameters

TBool aEnabled

SupportedSecurityMechanismsL()

IMPORT_C CDesC8Array *

SupportedSecurityMechanismsL

(

)

const

Gets all supported security mechanisms

__DbgTestInvariant()

void

__DbgTestInvariant

(

)

const [private]

Member Data Documentation

CSIPImplementation * iImplementation

CSIPImplementation *

iImplementation

[private]