Class CSIP

class CSIP : public CBase;

Description

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

Derivation

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

• CSIP - Class for connecting to SIP server

Members

Defined in CSIP:
Connection(), IsSigCompSupportedL(), NegotiatedSecurityMechanismL(), NewL(), NewLC(), SupportedSecurityMechanismsL(), ~CSIP()

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

Capability:

WriteDeviceData

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

Description

Two-phased constructor.

Parameters

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

Return value

CSIP * New object, ownership is transferred

Capability:

WriteDeviceData

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

Description

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

Parameters

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

Return value

CSIP * New object, ownership is transferred

IMPORT_C ~CSIP();

Description

Destructor.

IMPORT_C CDesC8Array *SupportedSecurityMechanismsL() const;

Description

Gets all supported security mechanisms

Return value

CDesC8Array * supported SIP security mechanisms names (e.g. digest); the ownership is transferred

IMPORT_C TBool IsSigCompSupportedL() const;

Description

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

Return value

TBool ETrue if supported, EFalse otherwise

IMPORT_C HBufC8 *NegotiatedSecurityMechanismL(const TDesC8 &aHop);

Description

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

Return value

HBufC8 * negotiated security mechanism or zero-pointer in case no security mechanism was negotiated with the next hop; the ownership is transferred

IMPORT_C CSIPConnection *Connection(TUint32 aIapId) const;

Description

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

Parameters

TUint32 aIapId IAP-id

Return value

CSIPConnection * sip connection or 0-pointer if connection does not exist. Ownership is not transferred.