CSIP Class Reference

#include <mw/sip.h>

Link against: sipclient.lib

class CSIP : public CBase

Inherits from

  • CSIP
    Public Member Functions
    ~CSIP()
    IMPORT_C CSIPConnection *Connection(TUint32)
    CSIPImplementation &Implementation()
    IMPORT_C TBoolIsSecurityHandlingEnabled()
    IMPORT_C TBoolIsSigCompSupportedL()
    IMPORT_C HBufC8 *NegotiatedSecurityMechanismL(const TDesC8 &)
    IMPORT_C CSIP *NewL(const TUid &, MSIPObserver &)
    IMPORT_C CSIP *NewLC(const TUid &, MSIPObserver &)
    IMPORT_C voidSetSecurityHandlingL(TBool)
    IMPORT_C CDesC8Array *SupportedSecurityMechanismsL()
    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()

    Detailed 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).

    Constructor & Destructor Documentation

    ~CSIP ( )

    IMPORT_C~CSIP()

    Destructor.

    Member Function Documentation

    Connection ( TUint32 )

    IMPORT_C CSIPConnection *Connection(TUint32aIapId)const

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

    ParameterDescription
    aIapIdIAP-id

    Returns: sip connection or 0-pointer if connection does not exist. Ownership is not transferred.

    Implementation ( )

    CSIPImplementation &Implementation()

    Returns the CSIPImplementation.

    Returns: CSIPImplementation

    IsSecurityHandlingEnabled ( )

    IMPORT_C TBoolIsSecurityHandlingEnabled()const

    IsSigCompSupportedL ( )

    IMPORT_C TBoolIsSigCompSupportedL()const

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

    Returns: ETrue if supported, EFalse otherwise

    NegotiatedSecurityMechanismL ( const TDesC8 & )

    IMPORT_C HBufC8 *NegotiatedSecurityMechanismL(const TDesC8 &aHop)

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

    ParameterDescription
    aHopthe 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

    NewL ( const TUid &, MSIPObserver & )

    IMPORT_C CSIP *NewL(const TUid &aUid,
    MSIPObserver &aObserver
    )[static]
    Two-phased constructor.
    capability
    WriteDeviceData
    ParameterDescription
    aUidan unique id that identifies client
    aObservera observer for asynchronous event

    Returns: New object, ownership is transferred

    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
    ParameterDescription
    aUidan unique id that identifies client
    aObservera observer for asynchronous event

    Returns: New object, ownership is transferred

    SetSecurityHandlingL ( TBool )

    IMPORT_C voidSetSecurityHandlingL(TBoolaEnabled)

    SupportedSecurityMechanismsL ( )

    IMPORT_C CDesC8Array *SupportedSecurityMechanismsL()const

    Gets all supported security mechanisms

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

    © Nokia 2011.