S60 3rd Edition API Reference: CSIP Class Reference CSIP Class Reference API published in: S60 2nd Ed
Link against: sipclient.lib
Capability Information Required Capabilities Location NetworkControl NetworkServices ReadDeviceData WriteDeviceData
#include <sip.h >
Detailed Description
PublishedAll Released
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).
Public Member Functions IMPORT_C ~CSIP () Destructor. IMPORT_C CDesC8Array * SupportedSecurityMechanismsL () const Gets all supported security mechanisms. IMPORT_C TBool IsSigCompSupportedL () const Checks if the signalling compression (SigComp) is supported. IMPORT_C HBufC8 * NegotiatedSecurityMechanismL (const TDesC8 &aHop) Gets negotiated security mechanism with the next hop on the signaling path. IMPORT_C CSIPConnection * Connection (TUint32 aIapId) const Checks if the user has a connection created for given IAP-id. CSIPImplementation & Implementation () Returns the CSIPImplementation. Static Public Member Functions static IMPORT_C CSIP * NewL (const TUid &aUid, MSIPObserver &aObserver) Two-phased constructor. static IMPORT_C CSIP * NewLC (const TUid &aUid, MSIPObserver &aObserver) Two-phased constructor.
Constructor & Destructor Documentation
Member Function Documentation
Checks if the user has a connection created for given IAP-id.
Parameters:
Returns: sip connection or 0-pointer if connection does not exist. Ownership is not transferred.
CSIPImplementation& CSIP::Implementation ( )
Returns the CSIPImplementation.
Returns: CSIPImplementation
IMPORT_C TBool CSIP::IsSigCompSupportedL ( ) const
Checks if the signalling compression (SigComp) is supported.
Leaves on failure with a system wide error code.
Returns: ETrue if supported, EFalse otherwise
IMPORT_C HBufC8* CSIP::NegotiatedSecurityMechanismL ( const TDesC8 & aHop )
Gets negotiated security mechanism with the next hop on the signaling path.
Parameters:
aHop the next hop's FQDN or numeric IP address
Returns: negotiated security mechanism or zero-pointer in case no security mechanism was negotiated with the next hop; the ownership is transferred
static IMPORT_C CSIP * CSIP::NewL ( const TUid & aUid , MSIPObserver & aObserver ) [static]
Two-phased constructor.
Parameters:
aUid an unique id that identifies client aObserver a observer for asynchronous event
Returns: New object, ownership is transferred WriteDeviceData
static IMPORT_C CSIP * CSIP::NewLC ( const TUid & aUid , MSIPObserver & aObserver ) [static]
Two-phased constructor.
Constructs an object and adds the pointer to the cleanup stack.
Parameters:
aUid an unique id that identifies client aObserver a observer for asynchronous event
Returns: New object, ownership is transferred WriteDeviceData
IMPORT_C CDesC8Array* CSIP::SupportedSecurityMechanismsL ( ) const
Gets all supported security mechanisms.
Returns: supported SIP security mechanisms names (e.g. digest); the ownership is transferred
