wlan_plat/wlan_power_save_plugin_api/inc/wlanpowersaveinterface.h
changeset 0 c40eb8fe8501
equal deleted inserted replaced
-1:000000000000 0:c40eb8fe8501
       
     1 /*
       
     2 * Copyright (c) 2002-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:  Defines the interface that powersave plugins have to implement
       
    15 *
       
    16 */
       
    17 
       
    18 /*
       
    19 * %version: 5 %
       
    20 */
       
    21 
       
    22 #ifndef WLANPOWERSAVEINTERFACE_H
       
    23 #define WLANPOWERSAVEINTERFACE_H
       
    24 
       
    25 /** The possible WLAN power save modes. */
       
    26 enum TWlanPowerSave
       
    27     {
       
    28     /** Allow the WLAN engine to decide the mode. */
       
    29     EWlanPowerSaveAutomatic, 
       
    30     /** Use a light power save mode. */
       
    31     EWlanPowerSaveLight,
       
    32     /** Use a deeper power save mode. */
       
    33     EWlanPowerSaveDeep,
       
    34     /** Disable power save completely. */
       
    35     EWlanPowerSaveNone
       
    36     };
       
    37 
       
    38 /**
       
    39 * Callback interface for adjusting the WLAN power save mode.
       
    40 *
       
    41 * This interface allows an ECom plugin implementing MWlanPowerSaveInterface
       
    42 * to adjust the WLAN power save mode. These callbacks are implemented by the
       
    43 * WLAN engine.
       
    44 *
       
    45 * @note The mode will stay until it is changed or the device is booted.
       
    46 * @note If power save has been disabled from the WLAN settings, this
       
    47 * setting has no effect.
       
    48 *
       
    49 * @lib wlmserversrv.dll
       
    50 * @since Series 60 3.0
       
    51 */
       
    52 class MWlanPowerSaveCallback
       
    53     {
       
    54     public: // New functions
       
    55 
       
    56         /**
       
    57         * Set the WLAN power save mode.
       
    58         * @since Series 60 3.0
       
    59         * @param aMode The power save mode to set.
       
    60         * @return A Symbian error code.
       
    61         */
       
    62         virtual TInt SetPowerSaveMode(
       
    63             TWlanPowerSave aMode ) = 0;
       
    64     };
       
    65 
       
    66 #endif // WLANPOWERSAVEINTERFACE_H