1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/mw/sipresolvedclient.h Wed Mar 31 12:27:01 2010 +0100
1.3 @@ -0,0 +1,109 @@
1.4 +/*
1.5 +* Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
1.6 +* All rights reserved.
1.7 +* This component and the accompanying materials are made available
1.8 +* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
1.9 +* which accompanies this distribution, and is available
1.10 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.11 +*
1.12 +* Initial Contributors:
1.13 +* Nokia Corporation - initial contribution.
1.14 +*
1.15 +* Contributors:
1.16 +*
1.17 +* Description:
1.18 +* Name : SipResolvedClient.h
1.19 +* Part of : SDK API, SIP Client Resolver API
1.20 +* Version : 1.0
1.21 +*
1.22 +*/
1.23 +
1.24 +
1.25 +
1.26 +#ifndef CSIPRESOLVEDCLIENT_H
1.27 +#define CSIPRESOLVEDCLIENT_H
1.28 +
1.29 +// INCLUDES
1.30 +#include <ecom/ecom.h>
1.31 +#include <stringpool.h>
1.32 +
1.33 +//FORWARD DECLARATIONS
1.34 +class CSIPHeaderBase;
1.35 +class CSIPContentTypeHeader;
1.36 +
1.37 +// CONSTANTS
1.38 +/** Interface UID of this ECOM interface*/
1.39 +const TUid KSIPResolvedClientIFUid = { 0x102010dd };
1.40 +
1.41 +// CLASS DEFINITION
1.42 +/**
1.43 +* @publishedAll
1.44 +* @released
1.45 +*
1.46 +* Interface that clients must realize
1.47 +* in order to enable client resolution mechanism upon the reception
1.48 +* of SIP request outside the SIP dialog. Data provided in
1.49 +* the ECOM resource file or optionally requested from the interface implementation
1.50 +* will be used for target client determination by the SIP implementation.
1.51 +* Note that channel UIDs must be unique accross all SIP clients e.g. clients may
1.52 +* use UIDs assigned for binaries.
1.53 +*/
1.54 +class CSIPResolvedClient : public CBase
1.55 + {
1.56 + public: // Destructor
1.57 +
1.58 + /**
1.59 + * Destructor
1.60 + */
1.61 + virtual inline ~CSIPResolvedClient();
1.62 +
1.63 + public: // Abstract methods
1.64 +
1.65 + /**
1.66 + * Returns the SIP client's channel UID that indicates client's
1.67 + * channel UID for connection with SIP e.g. CSIP::NewL()
1.68 + * @param aMethod the method of the SIP request
1.69 + * @param aRequestUri the request-URI of the SIP request
1.70 + * @param aHeaders all the headers in the SIP request
1.71 + * @param aContent SIP request body; zero-length descriptor if not present
1.72 + * @param aContentType the content-type of the SIP request.
1.73 + * Zero-pointer if body is not present.
1.74 + * @return SIP client's communication channel's UID
1.75 + */
1.76 + virtual TUid ChannelL(RStringF aMethod,
1.77 + const TDesC8& aRequestUri,
1.78 + const RPointerArray<CSIPHeaderBase>& aHeaders,
1.79 + const TDesC8& aContent,
1.80 + const CSIPContentTypeHeader* aContentType=0) = 0;
1.81 +
1.82 + /**
1.83 + * Requests the client to connect to SIP with resolved
1.84 + * UID in case there's no connection with resolved channel UID.
1.85 + * @param aUid previously resolved channel UID
1.86 + * @leave KErrNoMemory if out of memory
1.87 + * @leave KErrNotFound in case non-existing channel UID was provided
1.88 + */
1.89 + virtual void ConnectL(TUid aUid) = 0;
1.90 +
1.91 + /**
1.92 + * Requests the implementation to provide capabilities in XML format
1.93 + * in case they were not defined in the ECOM resource file. The cabablities
1.94 + * to be returned must be defined according to the same DTD.
1.95 + * This function will be invoked only if the capabilities are not
1.96 + * defined in the ECOM resource file.
1.97 + */
1.98 + virtual const TDesC8& Capabilities();
1.99 +
1.100 + public: // Data
1.101 +
1.102 + /// Unique key for implementations of this interface.
1.103 + TUid iInstanceKey;
1.104 +
1.105 + protected: // Constructors:
1.106 +
1.107 + inline CSIPResolvedClient();
1.108 + };
1.109 +
1.110 +#include <sipresolvedclient.inl>
1.111 +
1.112 +#endif // CSIPRESOLVEDCLIENT_H