wlan_plat/wlan_aws_plugin_api/inc/awsenginebase.h
changeset 0 c40eb8fe8501
child 3 6524e815f76f
equal deleted inserted replaced
-1:000000000000 0:c40eb8fe8501
       
     1 /*
       
     2 * Copyright (c) 2009 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:  Base class for the Adaptive WLAN Scan Engine.
       
    15 *
       
    16 */
       
    17 
       
    18 /*
       
    19 * %version: 5 %
       
    20 */
       
    21 
       
    22 
       
    23 #ifndef AWSENGINEBASE_H
       
    24 #define AWSENGINEBASE_H
       
    25 
       
    26 
       
    27 #include <ecom/ecom.h>
       
    28 #include <e32std.h>
       
    29 #include "awsinterface.h"
       
    30 
       
    31 /** Value for expiry when background scan should expire immediately. */
       
    32 const TUint32 KWlanBgScanMaxDelayExpireImmediately = 0;
       
    33 /** Value for background scan interval when background scan is off. */
       
    34 const TUint32 KWlanBgScanIntervalNever = 0;
       
    35 /** Value for Automatic background scan interval. */
       
    36 const TUint32 KWlanBgScanIntervalAutomatic = 0xFFFFFFFF;
       
    37 /** Value for AWS ECOM interface UID. */
       
    38 const TInt KAwsClientInterfaceUid = 0x2002700C;
       
    39 
       
    40 /**
       
    41  *  AWS Engine base class
       
    42  *  This class implements base class for AWS Engine.
       
    43  *
       
    44  *  @since S60 v5.2
       
    45  */
       
    46 class CAwsEngineBase : public CBase, public MAws
       
    47     {
       
    48 
       
    49 public:
       
    50     
       
    51     struct TAwsEngineConstructionParameters
       
    52         {
       
    53         MAwsBgScanProvider* aServiceProvider;
       
    54         TUint aServiceProviderInterfaceVersion;
       
    55         TUint& aAwsEngineInterfaceVersion;
       
    56         };
       
    57 
       
    58     /**
       
    59      * Two-phased constructor.
       
    60      * @param aUid UID of implementation to instantiate.
       
    61      * @param aConstructionParameters Pointer to construction parameters,
       
    62      *                                must not be NULL.
       
    63      * @return Pointer to the constructed instance.
       
    64      */
       
    65     inline static CAwsEngineBase* NewL(
       
    66             TInt aUid,
       
    67             TAwsEngineConstructionParameters* aConstructionParameters );
       
    68     
       
    69     /**
       
    70     * Destructor.
       
    71     */
       
    72     virtual ~CAwsEngineBase();
       
    73     
       
    74     /**
       
    75      * List implementations for AWS Plugin interface.
       
    76      * @param aImplInfoArray Array of implementation informations.
       
    77      */
       
    78     inline static void CAwsEngineBase::ListImplementationsL(
       
    79             RImplInfoPtrArray& aImplInfoArray);
       
    80 
       
    81 private: // data
       
    82 
       
    83     /**
       
    84      * Identifies the instance of an implementation created by
       
    85      * the ECOM framework.
       
    86      */
       
    87     TUid iInstanceIdentifier;
       
    88 
       
    89     };
       
    90 
       
    91 #include "awsenginebase.inl"
       
    92 
       
    93 #endif // AWSENGINEBASE_H