hsfw_plat/internet_connectivity_test_service_api/inc/ictsclientinterface.h
changeset 0 56b72877c1cb
equal deleted inserted replaced
-1:000000000000 0:56b72877c1cb
       
     1 /*
       
     2 * Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  Domain API 
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 #ifndef ICTSCLIENTINTERFACE_H
       
    22 #define ICTSCLIENTINTERFACE_H
       
    23 
       
    24 #include <e32base.h>
       
    25 #include <badesca.h>
       
    26 #include <ictscommon.h>
       
    27 
       
    28 class CIctsEngine;
       
    29 
       
    30 /**
       
    31  *  Interface class for clients to use
       
    32  *
       
    33  *  @lib ictsclientinterface.lib
       
    34  */
       
    35 class CIctsClientInterface : public CBase
       
    36     {
       
    37 
       
    38     public:
       
    39 
       
    40         /**
       
    41         * Static constructor.
       
    42         */    
       
    43         IMPORT_C static CIctsClientInterface* NewL( TUint32 aIapId, 
       
    44                                                     TUint32 aNetworkId,
       
    45                                                     MIctsObserver& aClient );
       
    46 
       
    47         /**
       
    48         * Destructor.
       
    49         */
       
    50         virtual ~CIctsClientInterface();
       
    51     
       
    52         /**
       
    53         * Starts internet connectivity test.
       
    54         *
       
    55         * @return None
       
    56         */
       
    57         IMPORT_C void StartL();
       
    58 
       
    59         /**
       
    60         * Cancels the internet connectivity test.
       
    61         *
       
    62         * @return None
       
    63         */
       
    64         IMPORT_C void CancelStartL();
       
    65 
       
    66         /**
       
    67         * Starts polling.
       
    68         *
       
    69         * @param aTime Polling time used
       
    70         * @param aInterval Time interval of execution
       
    71         * @return None
       
    72         */
       
    73         IMPORT_C void StartPolling( TInt aTime,
       
    74                                     TInt aInterval );
       
    75 
       
    76         /**
       
    77         * Stops polling
       
    78         *
       
    79         * @return None
       
    80         */
       
    81         IMPORT_C void StopPolling();
       
    82 
       
    83 
       
    84     private:
       
    85 
       
    86         /**
       
    87         * C++ default constructor.
       
    88         */
       
    89         CIctsClientInterface();
       
    90     
       
    91         /**
       
    92         * By default Symbian 2nd phase constructor is private.
       
    93         * @param aIapId IAP id 
       
    94         * @param aNetworkId Network id
       
    95         * @param aClient Client using test service
       
    96         */
       
    97         void ConstructL( TUint32 aIapId, 
       
    98                          TUint32 aNetworkId, 
       
    99                          MIctsObserver& aClient );
       
   100 
       
   101 
       
   102     private: // data
       
   103 
       
   104         /**
       
   105         * Intance of engine that handles ECom and protocols -> all tests.
       
   106         * Own.  
       
   107         */
       
   108         CIctsEngine* iEngine;
       
   109     
       
   110     };
       
   111 
       
   112 
       
   113 #endif // ICTSCLIENTINTERFACE_H