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:  Interfaces for WLAN Background Scan component and AWS component.

    15 *

    16 */

    17 

    18 /*

    19 * %version: 5 %

    20 */

    21 

    22 #ifndef AWSINTERFACE_H

    23 #define AWSINTERFACE_H

    24 

    25 

    26 #include <e32std.h>

    27 

    28 /**

    29  * The possible statuses of an AWS Power Save Mode.

    30  */

    31 enum TAwsPsMode

    32     {

    33     /**

    34      * No power save.

    35      */

    36     EAwsPsModeOff = 0,

    37     /**

    38      * Deep power save.

    39      */      

    40     EAwsPsModeDeep,

    41     /**

    42      * Light power save.

    43      */

    44     EAwsPsModeLight

    45     };

    46 

    47 /**

    48  *  @brief Interface definition for Adaptive WLAN Scanning component.

    49  *

    50  *  This class defines the methods for starting and stopping AWS.

    51  *  

    52  *  @since S60 v5.2

    53  */

    54 class MAws

    55     {

    56 

    57 public:

    58 

    59     /**

    60      * Start AWS.

    61      * 

    62      * @param aStatus Status of the calling active object. On successful

    63      *                completion contains KErrNone, otherwise one of the

    64      *                system-wide error codes.

    65      *

    66      * @since S60 v5.2

    67      */

    68     virtual void Start( TRequestStatus& aStatus ) = 0;

    69 

    70     /**

    71      * Stop AWS.

    72      *

    73      * @param aStatus Status of the calling active object. On successful

    74      *                completion contains KErrNone, otherwise one of the

    75      *                system-wide error codes.

    76      *                

    77      * @since S60 v5.2

    78      */

    79     virtual void Stop( TRequestStatus& aStatus ) = 0;

    80     

    81     /**

    82      * Set Power save mode.

    83      *

    84      * @param aMode new mode to be taken into use

    85      * @param aStatus Status of the calling active object. On successful

    86      *                completion contains KErrNone, otherwise one of the

    87      *                system-wide error codes.

    88      *                

    89      * @since S60 v5.2

    90      */

    91     virtual void SetPowerSaveMode( TAwsPsMode aMode, TRequestStatus& aStatus ) = 0;

    92 

    93     };

    94 

    95 /**

    96  *  @brief Interface definition for AWS background scan provider.

    97  *

    98  *  This class defines the methods AWS uses to command background scan provider.

    99  *  

   100  *  @since S60 v5.2

   101  */

   102 class MAwsBgScanProvider

   103     {

   104 

   105 public:

   106 

   107     /**

   108      * Set new background scan interval.

   109      *

   110      * @since S60 v5.2

   111      * @param aNewInterval new interval in seconds to be taken into use

   112      * @param aStatus Status of the calling active object. On successful

   113      *                completion contains KErrNone, otherwise one of the

   114      *                system-wide error codes.

   115      */

   116     virtual void SetInterval( TUint32 aNewInterval, TRequestStatus& aStatus ) = 0;

   117 

   118     };

   119 

   120 

   121 #endif // AWSINTERFACE_H