epoc32/include/mw/msenserviceconsumer.h
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
equal deleted inserted replaced
3:e1b950c65cb4 4:837f303aceeb
     1 /*
     1 /*
     2 * Copyright (c) 2002-2005 Nokia Corporation and/or its subsidiary(-ies). 
     2 * Copyright (c) 2002-2005 Nokia Corporation and/or its subsidiary(-ies).
     3 * All rights reserved.
     3 * All rights reserved.
     4 * This component and the accompanying materials are made available
     4 * This component and the accompanying materials are made available
     5 * 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
     5 * under the terms of "Eclipse Public License v1.0"
     6 * which accompanies this distribution, and is available
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
     8 *
     8 *
     9 * Initial Contributors:
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    10 * Nokia Corporation - initial contribution.
    11 *
    11 *
    12 * Contributors:
    12 * Contributors:
    13 *
    13 *
    14 * Description: Callback interface for service consumers        
    14 * Description:    Callback interface for service consumers        
    15 *
    15 *
    16 */
    16 */
       
    17 
       
    18 
       
    19 
    17 
    20 
    18 #ifndef M_SEN_SERVICE_CONSUMER_H
    21 #ifndef M_SEN_SERVICE_CONSUMER_H
    19 #define M_SEN_SERVICE_CONSUMER_H
    22 #define M_SEN_SERVICE_CONSUMER_H
    20 
    23 
    21 const TUid KSenInterfaceUidFilesObserver            = { 0x101F9742 }; // MSenFilesObserver
    24 const TUid KSenInterfaceUidFilesObserver            = { 0x101F9742 }; // MSenFilesObserver
       
    25 const TUid KSenInterfaceUidCoBrandingObserver       = { 0x10282C6C }; // MSenCoBrandingObserver
       
    26 const TUid KSenInterfaceUidAlrObserver              = { 0x10282C6D }; // MMobilityProtocolResp
       
    27 const TUid KSenInterfaceUidUserinfoProvider         = { 0x10282C6E }; // MSenUserInfoProvider
    22 const TUid KSenInterfaceUidAuthenticationProvider   = { 0x10282C6F }; // MSenAuthenticationProvider
    28 const TUid KSenInterfaceUidAuthenticationProvider   = { 0x10282C6F }; // MSenAuthenticationProvider
       
    29 const TUid KSenInterfaceUidHostletConsumer          = { 0xE760F697 }; // MSenAuthenticationProvider 
       
    30 
       
    31 
    23 // CLASS DECLARATION
    32 // CLASS DECLARATION
    24 
    33 
    25 /**
    34 /**
    26  * Callback interface for service consumers
    35  * Callback interface for service consumers
    27  */
    36  */
    87         */
    96         */
    88         virtual void SetStatus(const TInt aStatus) = 0;
    97         virtual void SetStatus(const TInt aStatus) = 0;
    89     };
    98     };
    90 
    99 
    91 /**
   100 /**
    92  * Callback interface for trnsfer progress observer
   101  * Callback interface for transfer progress observer. Typically,
       
   102  * this interface is implemented by applications that want to 
       
   103  * monitor how many bytes (of a file, request, or response) have
       
   104  * been sent or received during a transaction. Callback is thus
       
   105  * often integrated to progress bar implementations in UI layer.
       
   106  * Note: UID of this interface is KSenInterfaceUidFilesObserver.
    93  */
   107  */
    94 class MSenFilesObserver
   108 class MSenFilesObserver
    95     {
   109     {
    96     public:
   110     public:
    97     /**
   111     /**
   101     * @param aIncoming ETrue if it is incoming BLOB, EFalse if outgoing.
   115     * @param aIncoming ETrue if it is incoming BLOB, EFalse if outgoing.
   102     * @param aMessage SOAP message for incoming messages with BLOBs.
   116     * @param aMessage SOAP message for incoming messages with BLOBs.
   103     * @param aCid CID of current BLOB.
   117     * @param aCid CID of current BLOB.
   104     * @param aProgress Count of sent/received BLOB bytes.
   118     * @param aProgress Count of sent/received BLOB bytes.
   105     */
   119     */
   106     virtual void TransferProgress(TInt aTxnId, TBool aIncoming, const TDesC8& aMessage,
   120     virtual void TransferProgress( TInt aTxnId, 
   107             const TDesC8& aCid, TInt aProgress) = 0;
   121                                    TBool aIncoming, 
       
   122                                    const TDesC8& aMessage,
       
   123                                    const TDesC8& aCid, 
       
   124                                    TInt aProgress) = 0;
   108     };
   125     };
       
   126 class MSenHostletConsumer
       
   127     {
       
   128     public:
       
   129     virtual void SetConnectionId( TInt aConnectionId ) = 0; 
       
   130     };    
       
   131 /**
       
   132  * Callback interface for extended consumer interface.
       
   133  * When this interface is provided to service connection as constructor
       
   134  * argument, the service connection (web services stack) can later on 
       
   135  * query for a variety of different interfaces, extensions, from the
       
   136  * application. Each extension (interface) is has unique identifier (UID).
       
   137  */    
   109 class MSenExtendedConsumerInterface
   138 class MSenExtendedConsumerInterface
   110     {       
   139     {       
   111     public: 
   140     public: 
       
   141         /**
       
   142         * Service connection calls this method several times, passing a different
       
   143         * UID per each call. If application wants to provide particular interface
       
   144         * to service connection (web services stack), it needs to return a pointer
       
   145         * to such M-class as a return value of this method. For any interface, that
       
   146         * application has not implemented, it is supposed to return NULL.
       
   147         * @param aUID is the unique identifier of some interface
       
   148         * @return value should be a valid (void) pointer to any interface implemented
       
   149         * by the application. NULL signalizes that application does not provide interface
       
   150         * for give UID. 
       
   151         */    
   112 	    inline virtual TAny* GetInterfaceByUid( TUid /* aUID */ ) { return NULL; };
   152 	    inline virtual TAny* GetInterfaceByUid( TUid /* aUID */ ) { return NULL; };
   113     };    
   153     };
   114 
   154 
   115 #endif // M_SEN_SERVICE_CONSUMER_H
   155 #endif // M_SEN_SERVICE_CONSUMER_H
   116 
   156 
   117 // End of File
   157 // End of File