epoc32/include/mw/msenserviceconsumer.h
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
     1.1 --- a/epoc32/include/mw/msenserviceconsumer.h	Wed Mar 31 12:27:01 2010 +0100
     1.2 +++ b/epoc32/include/mw/msenserviceconsumer.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -1,25 +1,34 @@
     1.4  /*
     1.5 -* Copyright (c) 2002-2005 Nokia Corporation and/or its subsidiary(-ies). 
     1.6 +* Copyright (c) 2002-2005 Nokia Corporation and/or its subsidiary(-ies).
     1.7  * All rights reserved.
     1.8  * This component and the accompanying materials are made available
     1.9 -* 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.10 +* under the terms of "Eclipse Public License v1.0"
    1.11  * which accompanies this distribution, and is available
    1.12 -* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.13 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.14  *
    1.15  * Initial Contributors:
    1.16  * Nokia Corporation - initial contribution.
    1.17  *
    1.18  * Contributors:
    1.19  *
    1.20 -* Description: Callback interface for service consumers        
    1.21 +* Description:    Callback interface for service consumers        
    1.22  *
    1.23  */
    1.24  
    1.25 +
    1.26 +
    1.27 +
    1.28  #ifndef M_SEN_SERVICE_CONSUMER_H
    1.29  #define M_SEN_SERVICE_CONSUMER_H
    1.30  
    1.31  const TUid KSenInterfaceUidFilesObserver            = { 0x101F9742 }; // MSenFilesObserver
    1.32 +const TUid KSenInterfaceUidCoBrandingObserver       = { 0x10282C6C }; // MSenCoBrandingObserver
    1.33 +const TUid KSenInterfaceUidAlrObserver              = { 0x10282C6D }; // MMobilityProtocolResp
    1.34 +const TUid KSenInterfaceUidUserinfoProvider         = { 0x10282C6E }; // MSenUserInfoProvider
    1.35  const TUid KSenInterfaceUidAuthenticationProvider   = { 0x10282C6F }; // MSenAuthenticationProvider
    1.36 +const TUid KSenInterfaceUidHostletConsumer          = { 0xE760F697 }; // MSenAuthenticationProvider 
    1.37 +
    1.38 +
    1.39  // CLASS DECLARATION
    1.40  
    1.41  /**
    1.42 @@ -89,7 +98,12 @@
    1.43      };
    1.44  
    1.45  /**
    1.46 - * Callback interface for trnsfer progress observer
    1.47 + * Callback interface for transfer progress observer. Typically,
    1.48 + * this interface is implemented by applications that want to 
    1.49 + * monitor how many bytes (of a file, request, or response) have
    1.50 + * been sent or received during a transaction. Callback is thus
    1.51 + * often integrated to progress bar implementations in UI layer.
    1.52 + * Note: UID of this interface is KSenInterfaceUidFilesObserver.
    1.53   */
    1.54  class MSenFilesObserver
    1.55      {
    1.56 @@ -103,14 +117,40 @@
    1.57      * @param aCid CID of current BLOB.
    1.58      * @param aProgress Count of sent/received BLOB bytes.
    1.59      */
    1.60 -    virtual void TransferProgress(TInt aTxnId, TBool aIncoming, const TDesC8& aMessage,
    1.61 -            const TDesC8& aCid, TInt aProgress) = 0;
    1.62 +    virtual void TransferProgress( TInt aTxnId, 
    1.63 +                                   TBool aIncoming, 
    1.64 +                                   const TDesC8& aMessage,
    1.65 +                                   const TDesC8& aCid, 
    1.66 +                                   TInt aProgress) = 0;
    1.67      };
    1.68 +class MSenHostletConsumer
    1.69 +    {
    1.70 +    public:
    1.71 +    virtual void SetConnectionId( TInt aConnectionId ) = 0; 
    1.72 +    };    
    1.73 +/**
    1.74 + * Callback interface for extended consumer interface.
    1.75 + * When this interface is provided to service connection as constructor
    1.76 + * argument, the service connection (web services stack) can later on 
    1.77 + * query for a variety of different interfaces, extensions, from the
    1.78 + * application. Each extension (interface) is has unique identifier (UID).
    1.79 + */    
    1.80  class MSenExtendedConsumerInterface
    1.81      {       
    1.82      public: 
    1.83 +        /**
    1.84 +        * Service connection calls this method several times, passing a different
    1.85 +        * UID per each call. If application wants to provide particular interface
    1.86 +        * to service connection (web services stack), it needs to return a pointer
    1.87 +        * to such M-class as a return value of this method. For any interface, that
    1.88 +        * application has not implemented, it is supposed to return NULL.
    1.89 +        * @param aUID is the unique identifier of some interface
    1.90 +        * @return value should be a valid (void) pointer to any interface implemented
    1.91 +        * by the application. NULL signalizes that application does not provide interface
    1.92 +        * for give UID. 
    1.93 +        */    
    1.94  	    inline virtual TAny* GetInterfaceByUid( TUid /* aUID */ ) { return NULL; };
    1.95 -    };    
    1.96 +    };
    1.97  
    1.98  #endif // M_SEN_SERVICE_CONSUMER_H
    1.99