/*

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of the License "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:  Class implementing WLAN background scan logic

*

*/

/*

*/

#ifndef WLANBGSCAN_H

#define WLANBGSCAN_H

#include "awsinterface.h"

#include "awsenginebase.h"

#include "wlanscanproviderinterface.h"

/**

 *  WLAN Background Scan

 *  This class implements WLAN Background Scan logic.

 *  

 *  @since S60 S60 v5.2

 */

NONSHARABLE_CLASS( CWlanBgScan ) :

    public MWlanBgScanProvider,

    public MWlanTimerServiceCallback,

    {

public:

    /**

     * States for Auto period.

     */

    enum TWlanBgScanAutoPeriod

        {

        EAutoPeriodNone = 0,

        EAutoPeriodNight,

        EAutoPeriodDay

        };

    /**

     * Describes relation of time to time range.

     */

    enum TRelation

        {

        ESmaller,

        EInsideRange,

        EGreater

        };

    /**

     * Two-phased constructor.

     */

    /**

    * Destructor.

    */

    virtual ~CWlanBgScan();

    /**

     * From MWlanBgScanProvider.

     * Called when Scan has been completed.

     *

     * @since S60 v5.2

     */

    void ScanComplete();

    /**

     * From MWlanBgScanProvider.

     * Issued when WLAN is disconnected.

     *

     * @since S60 v5.2

     */

    void NotConnected();

    /**

     * From MWlanBgScanProvider.

     * Whether background scan is enabled.

     *

     * @since S60 v5.2

     * @return True if background scan is enabled,

     *         False otherwise.

     */

    TBool IsBgScanEnabled();

    /**

     * From MWlanBgScanProvider.

     * Notification about changed settings.

     *

     * @since S60 v5.2

     * 

     * @param aSettings new settings to be taken into use

     */

    void NotifyChangedSettings( MWlanBgScanProvider::TWlanBgScanSettings& aSettings );

    /**

     * From MAwsBgScanProvider.

     * Set new background scan interval.

     * Asynchronous method to set new background scan interval, executed in

     *

     * @since S60 v5.2

     * @param aNewInterval new interval to be taken into use

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

     *                completion contains KErrNone, otherwise one of the

     *                system-wide error codes.

     */

    void SetInterval( TUint32 aNewInterval, TRequestStatus& aReportStatus );

    /**

     * From MWlanTimerServiceCallback.

     * OnTimeout.

     * Requested time has elapsed.

     *

     * @since S60 v5.2

     */

    void OnTimeout();

    /**

     * From MWlanBgScanCommandListener.

     * DoSetInterval.

     * This method is called by the command queue when

     * interval change request is processed.

     * @param aNewInterval new interval to be taken into use

     */

    void DoSetInterval( TUint32 aNewInterval );

    /**

     */

    /**

     */

    /**

     *

     * @since S60 v5.2

     */

    /**

     * Request callback when interval change should take place.

     *

     * @since S60 v5.2

     */

    void ScheduleAutoIntervalChange();

    /**

     * Get current Auto Background Scan interval.

     *

     * @since S60 v5.2

     * 

     * @return interval

     */

    TUint32 CurrentAutoInterval();

    /**

     *

     * @since S60 v5.2

     */

    /**

     */

    /**

     * Get next time when to change Auto interval.

     *

     * @since S60 v5.2

     * 

     * @return time to change interval

     */

    TTime AutoIntervalChangeAt();

    /**

     * See how time is related to a time range.

     *

     * @param aTime time to be checked

     * @param aStart start of range

     * @param aEnd end of range

     * @return relation

     * @since S60 v5.2

     */

    TRelation TimeRelationToRange( const TTime& aTime, TUint aRangeStart, TUint aRangeEnd ) const;

    /**

     * Check the proposed settings are valid.

     *

     * @since S60 v5.2

     *

     * @param aSettingsToUse settings that can be used [OUT]

     * @param aProposedSettings proposed settings [IN]

     */

    void CheckSettings(

            MWlanBgScanProvider::TWlanBgScanSettings& aSettingsToUse,

            const MWlanBgScanProvider::TWlanBgScanSettings& aProposedSettings ) const;

    /**

     * Is interval change needed.

     *

     * @since S60 v5.2

     * @return ETrue if interval change is needed,

     *         EFalse otherwise.

     */

    TBool IsIntervalChangeNeeded();

private: // data

    /**

     * Reference to the Scan Result Provider

     */

    MWlanScanResultProvider& iProvider;

    /**

     */

    /**

     * Current Auto period. 

     */

    TWlanBgScanAutoPeriod iAutoPeriod;

    /**

     */

    /**

     */

    };

#endif // WLANBGSCAN_H