S60 3rd Edition API Reference: CSIPResolvedClient Class Reference

CSIPResolvedClient Class Reference

API published in: S60 3rd Ed

Link against:

Capability Information

Required Capabilities

ProtServ

#include <sipresolvedclient.h>

Detailed Description

PublishedAll
Released
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.

Public Member Functions

virtual ~CSIPResolvedClient ()
 Destructor.
virtual TUid ChannelL (RStringF aMethod, const TDesC8 &aRequestUri, const RPointerArray< CSIPHeaderBase > &aHeaders, const TDesC8 &aContent, const CSIPContentTypeHeader *aContentType=0)=0
 Returns the SIP client's channel UID that indicates client's channel UID for connection with SIP e.g.
virtual void ConnectL (TUid aUid)=0
 Requests the client to connect to SIP with resolved UID in case there's no connection with resolved channel UID.
virtual const TDesC8 & Capabilities ()
 Requests the implementation to provide capabilities in XML format in case they were not defined in the ECOM resource file.

Data Fields

TUid iInstanceKey
 Unique key for implementations of this interface.

Protected Member Functions

 CSIPResolvedClient ()

Constructor & Destructor Documentation

virtual CSIPResolvedClient::~CSIPResolvedClient (   )  [inline, virtual]
 

Destructor.

CSIPResolvedClient::CSIPResolvedClient (   )  [inline, protected]
 

Member Function Documentation

virtual const TDesC8& CSIPResolvedClient::Capabilities (   )  [virtual]
 

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.

virtual TUid CSIPResolvedClient::ChannelL ( RStringF  aMethod,
const TDesC8 &  aRequestUri,
const RPointerArray< CSIPHeaderBase > &  aHeaders,
const TDesC8 &  aContent,
const CSIPContentTypeHeader *  aContentType = 0
)  [pure virtual]
 

Returns the SIP client's channel UID that indicates client's channel UID for connection with SIP e.g.

CSIP::NewL()

Parameters:
aMethod the method of the SIP request
aRequestUri the request-URI of the SIP request
aHeaders all the headers in the SIP request
aContent SIP request body; zero-length descriptor if not present
aContentType the content-type of the SIP request. Zero-pointer if body is not present.
Returns:
SIP client's communication channel's UID
virtual void CSIPResolvedClient::ConnectL ( TUid  aUid  )  [pure virtual]
 

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

Parameters:
aUid previously resolved channel UID
Leave:
KErrNoMemory if out of memory
Leave:
KErrNotFound in case non-existing channel UID was provided

Field Documentation

TUid CSIPResolvedClient::iInstanceKey
 

Unique key for implementations of this interface.

The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top