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 the License "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:  This abstract class defines WLAN scan provider interface.

    15 *

    16 */

    17 

    18 /*

    19 * %version: 4 %

    20 */

    21 

    22 

    23 #ifndef WLANSCANPROVIDERINTERFACE_H

    24 #define WLANSCANPROVIDERINTERFACE_H

    25 

    26 /**

    27  * @brief Interface definition for WLAN Scan Result Provider API.

    28  *

    29  * This class defines the methods used for issuing and cancelling Scan requests.

    30  *

    31  * @since S60 v5.2

    32  */

    33 class MWlanScanResultProvider

    34     {

    35 

    36 public:

    37 

    38     /**

    39      * Issue scan request.

    40      *

    41      * @since S60 v5.2

    42      * @param aMaxDelay Maximum amount of seconds the client is willing to wait for

    43      *                  the availability results. The valid range is from 0 to 1200

    44      *                  seconds.

    45      */

    46     virtual void Scan( const TUint& aMaxDelay ) = 0;

    47 

    48     /**

    49      * Cancel pending scan request.

    50      *

    51      * @since S60 v5.2

    52      */        

    53     virtual void CancelScan() = 0;

    54 

    55     };

    56 

    57 

    58 

    59 /**

    60  * @brief Interface definition for WLAN Background Scan Provider API.

    61  *

    62  * This class defines the methods WLAN engine uses to communicate with 

    63  * WLAN Background Scan provider.

    64  *

    65  * @since S60 v5.2

    66  */

    67 class MWlanBgScanProvider

    68     {

    69 

    70 public:

    71     

    72     struct TWlanBgScanSettings

    73         {

    74         TUint32 backgroundScanInterval;

    75         TUint psmServerMode;

    76         TUint bgScanPeakStartTime;

    77         TUint bgScanPeakEndTime;

    78         TUint32 bgScanIntervalPeak;

    79         TUint32 bgScanIntervalOffPeak;

    80         

    81         TWlanBgScanSettings() :

    82             backgroundScanInterval( 0 ),

    83             psmServerMode( 0 ),

    84             bgScanPeakStartTime( 0),

    85             bgScanPeakEndTime( 0 ),

    86             bgScanIntervalPeak( 0 ),

    87             bgScanIntervalOffPeak( 0 )

    88             { }

    89         

    90         TWlanBgScanSettings( TUint32 aBackgroundScanInterval,

    91                             TUint aPsmServerMode,

    92                             TUint aBgScanPeakStartTime,

    93                             TUint aBgScanPeakEndTime,

    94                             TUint32 aBgScanIntervalPeak,

    95                             TUint32 aBgScanIntervalOffPeak ) :

    96             backgroundScanInterval( aBackgroundScanInterval ),

    97             psmServerMode( aPsmServerMode ),

    98             bgScanPeakStartTime( aBgScanPeakStartTime),

    99             bgScanPeakEndTime( aBgScanPeakEndTime ),

   100             bgScanIntervalPeak( aBgScanIntervalPeak ),

   101             bgScanIntervalOffPeak( aBgScanIntervalOffPeak )

   102             { }

   103         

   104         };

   105 

   106     /**

   107      * Called when Scan is complete.

   108      *

   109      * @since S60 v5.2

   110      */

   111     virtual void ScanComplete() = 0;

   112         

   113     /**

   114      * Issued when WLAN is disconnected.

   115      *

   116      * @since S60 v5.2

   117      */

   118     virtual void NotConnected() = 0;

   119     

   120     /**

   121      * Whether background scan is enabled.

   122      *

   123      * @since S60 v5.2

   124      * @return True if background scan is enabled,

   125      *         False otherwise.

   126      */

   127     virtual TBool IsBgScanEnabled() = 0;

   128     

   129     /**

   130      * Notification about changed settings.

   131      *

   132      * @since S60 v5.2

   133      * 

   134      * @param aSettings new settings to be taken into use

   135      */

   136     virtual void NotifyChangedSettings( TWlanBgScanSettings& aSettings ) = 0;

   137 

   138     };

   139 

   140 

   141 #endif // WLANSCANPROVIDERINTERFACE_H