Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: sipresolvedclient.h

Class CSIPResolvedClient

class CSIPResolvedClient : public CBase;

Description

Interface that clients must realize in order to enable client resolution mechanism upon the reception of SIP request outside the SIP dialog. Data provided in the ECOM resource file or optionally requested from the interface implementation will be used for target client determination by the SIP implementation. Note that channel UIDs must be unique accross all SIP clients e.g. clients may use UIDs assigned for binaries.

Derivation

Members

Defined in CSIPResolvedClient:
CSIPResolvedClient(), Capabilities(), ChannelL(), ConnectL(), iInstanceKey, ~CSIPResolvedClient()

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


Construction and destruction


~CSIPResolvedClient()

inline virtual ~CSIPResolvedClient();

Description

Destructor


CSIPResolvedClient()

protected: inline CSIPResolvedClient();

Description

[Top]


Member functions


ChannelL()

virtual TUid ChannelL(RStringF aMethod, const TDesC8 &aRequestUri, const RPointerArray< CSIPHeaderBase > &aHeaders, const TDesC8 &aContent, const CSIPContentTypeHeader *aContentType=0)=0;

Description

Returns the SIP client's channel UID that indicates client's channel UID for connection with SIP e.g. CSIP::NewL()

Parameters

RStringF aMethod

the method of the SIP request

const TDesC8 &aRequestUri

the request-URI of the SIP request

const RPointerArray< CSIPHeaderBase > &aHeaders

all the headers in the SIP request

const TDesC8 &aContent

SIP request body; zero-length descriptor if not present

const CSIPContentTypeHeader *aContentType

the content-type of the SIP request. Zero-pointer if body is not present.

Return value

TUid

SIP client's communication channel's UID


ConnectL()

virtual void ConnectL(TUid aUid)=0;

Description

Requests the client to connect to SIP with resolved UID in case there's no connection with resolved channel UID.

Parameters

TUid aUid

previously resolved channel UID

Leave codes

KErrNoMemory

if out of memory

KErrNotFound

in case non-existing channel UID was provided


Capabilities()

inline virtual const TDesC8 &Capabilities();

Description

Requests the implementation to provide capabilities in XML format in case they were not defined in the ECOM resource file. The cabablities to be returned must be defined according to the same DTD. This function will be invoked only if the capabilities are not defined in the ECOM resource file.

Return value

const TDesC8 &

[Top]


Member data


iInstanceKey

TUid iInstanceKey;

Description

Unique key for implementations of this interface.