/*

* Copyright (c) 2005-2010 Nokia Corporation and/or its subsidiary(-ies).

* 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:  Main server

*

*/

/*

*/

#ifndef WLMSERVER_H

#define WLMSERVER_H

#include <wdbifwlansettings.h>  // Used in SIAPSettings.

#include "abs_core_server_callback.h"

#include "abs_core_server.h"

#include "abs_wlan_eapol_callback.h"

#include "wlanscanproviderinterface.h"

#include "core_server.h"

#include "wlmnotification.h"

#include "wlandevicesettings.h"

#include "wlanscanresultcache.h"

#include "wlmplatform.h"

#include "umac_types.h" // TIndication

#include "wlanconversionutil.h"

#include "wlancontrolinterface.h"

#include "wlaneapolinterface.h"

#include "wlaneapolclient.h"

#include "wlangenericplugin.h"

class CWlmDriverIf;

class CWlanSsidListDb;

class CWlanTimerServices;

/**

 * Command Ids to be used un the asynchronous core service requests

 * External commands coming from clients get request id that is > KWlanExtCmdBase

 * Values 0-KWlanExtCmdBase are reserved for internal usage.

 */

const TUint32 KWlanIntCmdNull = 0;

const TUint32 KWlanIntCmdBackgroundScan = 1;

const TUint32 KWlanIntCmdEnableWlan = 2;

const TUint32 KWlanIntCmdDisableWlan = 3;

const TUint32 KWlanIntCmdSetPowerSave = 4;

const TUint32 KWlanExtCmdBase = 100;

/** Timer interval value for disabling background scan. */

const TInt KBackgroundScanIntervalNever = 0;

/** UID for WLAN Power Save Test Notifier */

const TUid KUidWlanPowerSaveTestNote = { 0x101F6D4F };

/**

* The server for WLAN services. Counterpart of RWLMServer.

*

* @lib wlmserversrv.lib

* @since Series 60 3.0

*/

NONSHARABLE_CLASS( CWlmServer ) : 

    public CServer2, 

    public abs_core_server_callback_c, 

    public MWlmPlatformCallback,

    public MWlanEapolCallbackInterface,

    public MWlanScanResultProvider

    {

    public:  // Constructors and destructor

        /** 

         * map entry is used for queuing service requests

         */

        struct SRequestMapEntry

            {

            u32_t iRequestId;

            TUint iSessionId;

            RMessagePtr2 iMessage;

            TWLMCommands iFunction;

            TAny* iParam0;

            TAny* iParam1;

            TAny* iParam2;

            TAny* iParam3;

            TTime* iTime;

            SRequestMapEntry() :

                iRequestId( 0 ),

                iSessionId( 0 ),

                iMessage(),

                iParam0( NULL ),

                iParam1( NULL ),

                iParam2( NULL ),

                iParam3( NULL ),

                iTime( NULL )

                { }

            };

        /**

         * Bit definitions for WLAN features.

         */

        enum TWlanFeature

            {

            /** Initialisation value. */

            EWlanFeatureNone                = 0x00000000,

            /** Whether WAPI is enabled. */

            EWlanFeatureWapi                = 0x00000001,

            /** Whether power save test is enabled. */

            EWlanFeaturePowerSaveTest       = 0x00000002,

            /** Whether 802.11k is enabled. */

            EWlanFeature802dot11k           = 0x00000004

            };

        /**

         * Two-phased constructor.

         */

        IMPORT_C static CWlmServer* NewL();

        /**

         * Destructor.

         */

        virtual ~CWlmServer();

    public: // New functions

        /** 

        * Initialises the server thread.

        *

        * The compilation macro is to ease to run the server as a

        * thread and as a own process.

        *

        * @since Series 60 3.0

        * @return Standard Symbian error.

        */

        IMPORT_C static TInt StartServerThread();

        /**

        * Get the type of scan allowed.

        * @return Type of scan allowed.

        */

        inline TWLMScanType GetScanType();

        /**

        * SetIconState sets the status of WLAN icon on cover display.

        * @param aStatus The WLAN icon status.

        * @return Symbian error code.

        */

        inline TInt SetIconState( TWlmIconStatus aStatus );

        /**

        * Find out the IAP to join to.

        * @param aLanServiceId  ID of the WLAN IAP settings to been joined.

        * @param aWlanSettings  (OUT) The WLAN IAP settings.

        * @param aSecondaryList (OUT) List of secondary SSIDs.

        */

        void GetIapSettingsL(

            const TUint32 aLanServiceId,

            SWLANSettings& aWlanSettings,

            RArray<TWlanSecondarySsid>& aSecondaryList );

        /**

        * Update the availability information.

        * @param aAvailability Availability information for the

        *                      Connection Monitor server.

        * @param aNetNetworksDetected Whether new networks have been detected.

        * @param aOldNetworksLost Whether one or more old networks have been lost.

        */

        inline void UpdateAvailability(

            TBool aAvailability,

            TBool aNewNetworksDetected = EFalse,

            TBool aOldNetworksLost = EFalse );

        /**

         * Notify changed PSM server mode

         *

         * @since Series 60 5.2

         * @param aSessionId ID identifying the session.

         * @param aMessage containing the service request

         */

        void NotifyChangedPsmSrvMode(

            TUint aSessionId,

            const RMessage2& aMessage );    

    public: // Functions from base classes

        /** 

        * From abs_core_server_callback_c Send a notification.

        * @param notification The notification to send.

        * @param data_length  Optional data length.

        * @param data         Pointer to optional data.

        */

        virtual void notify(

            core_notification_e notification,

            int_t data_length,

            const u8_t* data );

        /**

         * From abs_core_server_callback_c 

         * Notify about country information received from APs.

         * @param request_id Identification of the corresponding request.

         * @param found_region WLAN region information obtained from the AP's country information.

         * @param inconsistent_info Information whether different APs gave inconsistent country information.

         */

        virtual void store_ap_country_info(

        		u32_t request_id,

        		const core_wlan_region_e& found_region,

        	    bool_t inconsistent_info );        

        /**

        * From abs_core_server_callback_c 

        * Get the current regulatory domain.

        * @param request_id Identification of the corresponding request.

        * @return Current regulatory domain.

        * @param mcc_known Is the current mobile country code available

        */

        virtual void get_regulatory_domain(

            u32_t request_id,

            core_wlan_region_e& region,

            bool_t& mcc_known );

        /**

         * From abs_core_server_callback_c 

         * An asynchronous request from the adaptation layer has been completed.

         *

         * @since S60 v3.1

         * @param request_id Identification of the corresponding request.

         * @param status Completion status of the request.

         */

        virtual void request_complete(

            u32_t request_id,

            core_error_e status );

        /**

         * From abs_core_server_callback_c 

         * Cancel a pending asynchronous request.

         * 

         * @since S60 v3.1

         * @param request_id Identification of the corresponding request.

         */

        virtual void cancel_request(

            u32_t request_id );

        /**

         * From abs_core_server_callback_c 

         * Initialize interface to EAPOL.

         *

         * @since S60 v3.2

         * @param mode Operating mode to use.

         * @param partner Pointer to partner instance.

         * @return Status value of operation.

         */

        virtual u32_t load_eapol(

            core_eapol_operating_mode_e mode,

            abs_wlan_eapol_callback_c* const partner );

        /**

         * From abs_core_server_callback_c 

         * Shutdown EAPOL.

         *

         * @since S60 v3.2

         * @return Status value of operation.

         */

        virtual u32_t shutdown();

        /**

         * From abs_core_server_callback_c 

         * Configure EAPOL.

         *

         * @since S60 v3.2

         * @param header_offset Offset of EAP-header in packet_send.

         * @param MTU Maximum transfer unit (MTU).

         * @param trailer_length Length of trailer needed by lower levels..

         * @return Status value of operation.

         */

        virtual u32_t configure(

            const u32_t header_offset,

            const u32_t MTU,

            const u32_t trailer_length );

        /**

         * From abs_core_server_callback_c 

         * Send data to EAPOL.

         *

         * @since S60 v3.2

         * @param data Pointer to data to be send.

         * @param length Length of data to be send.

         * @return Status value of operation.

         */

        virtual u32_t process_data(

            const void * const data,

            const u32_t length );

        /**

        * From CServer2

        * @since Series 60 3.0

        * @param aVersion not used

        * @param aMessage not used

        * @return session object

        */

        virtual CSession2* NewSessionL(

            const TVersion& aVersion,

            const RMessage2& aMessage ) const;

        /**

        * @since Series 60 3.0

        * @param ?arg1 ?description

        * @return ?description

        */

        virtual void NotifyAdd(

            CNotificationBase& aNotification );

        /**

        * @since Series 60 3.0

        * @param ?arg1 ?description

        * @return ?description

        */

        virtual void NotifyRemove(

            CNotificationBase& aNotification );

        /**

         * Connect

         * @param aSessionId ID identifying the session.

         * @param aMessage containing the service request

         */

        virtual void Connect(

            TUint aSessionId,

            const RMessage2& aMessage );

        /**

         * Cancel an outstanding connect request.

         * @param aSessionId ID identifying the session.

         * @param aMessage containing the service request

         */

        virtual void CancelConnect(

            TUint aSessionId,

            const RMessage2& aMessage );

        /**

         * GetCurrentBSSID

         * @since Series 60 3.0

         * @param aSessionId ID identifying the session.         

         * @param aMessage containing the service request

         */

        virtual void GetCurrentBSSID(

            TUint aSessionId,

            const RMessage2& aMessage );

        /**

         * GetCurrentRCPI

         * @since Series 60 3.0

         * @param aSessionId ID identifying the session.         

         * @param aMessage containing the service request

         */

        virtual void GetCurrentRCPI(

            TUint aSessionId,

            const RMessage2& aMessage );

        /**

        * @since Series 60 3.0

        * @param aSessionId ID identifying the session.        

        * @param aMessage containing the service request

        */

        virtual void GetCurrentSSID(

            TUint aSessionId,

            const RMessage2& aMessage );

        /**

        * GetCurrentSecurityMode

        * @since Series 60 3.0

        * @param aSessionId ID identifying the session.        

        * @param aMessage containing the service request

        */

        virtual void GetCurrentSecurityMode(

            TUint aSessionId,

            const RMessage2& aMessage );

        /**

         * GetCurrentSystemMode

         * @since Series 60 3.0

         * @param aSessionId ID identifying the session.         

         * @param aMessage containing the service request

         */

        virtual void GetCurrentSystemMode(

            TUint aSessionId,

            const RMessage2& aMessage );

        /**

         * Asks for connection state

         * @since Series 60 3.0

         * @param aSessionId ID identifying the session.         

         * @param aMessage containing the service request

         */

        virtual void GetConnectionState(

            TUint aSessionId,

            const RMessage2& aMessage );

        /**

         * Performs scan

         * @since Series 60 3.0

         * @param aSessionId ID identifying the session.         

         * @param aMessage containing the service request

         */

        virtual void GetScanResult(

            TUint aSessionId,

            const RMessage2& aMessage );

        /**

         * Cancel an outstanding scan request.

         * @since Series 60 3.2

         * @param aSessionId ID identifying the session.         

         * @param aMessage containing the service request

         */

        virtual void CancelGetScanResult(

            TUint aSessionId,

            const RMessage2& aMessage );

        /**

         * Determines which IAPs are currently available

         * @since Series 60 3.1

         * @param aSessionId ID identifying the session.         

         * @param aMessage containing the service request

         */

        void GetAvailableIaps(

            TUint aSessionId,

            const RMessage2& aMessage );

        /**

         * Cancel an outstanding IAP availability request.

         * @since Series 60 3.2

         * @param aSessionId ID identifying the session.         

         * @param aMessage containing the service request

         */

        void CancelGetAvailableIaps(

            TUint aSessionId,

            const RMessage2& aMessage );

        /**

         * @since Series 60 3.0

         * @param aSessionId ID identifying the session.         

         * @param aMessage containing the service request

         */

        virtual void ReleaseComplete(

            TUint aSessionId,

            const RMessage2& aMessage );

        /**

        * @since Series 60 3.0

        * @param ?arg1 ?description

        * @return ?description

        */

        virtual TUint NotifySessionCreated();

        /**

        * @since Series 60 3.0

        * @param aSessionId ID identifying the session.

        */

        virtual void NotifySessionClosed( TUint aSessionId );

        /**

         * NotifyChangedSettings

         * @since Series 60 3.0

         * @param aSessionId ID identifying the session.         

         * @param aMessage containing the service request

         */

        virtual void NotifyChangedSettings(

            TUint aSessionId,

            const RMessage2& aMessage );

        /**

         * AddBssidToRoguelist

         * @since Series 60 3.0

         * @param aSessionId ID identifying the session.         

         * @param aMessage containing the service request

         */

        virtual void AddBssidToRoguelist(

            TUint aSessionId,

            const RMessage2& aMessage );

        /**

         * UpdateRcpNotificationBoundary

         * @since Series 60 3.0

         * @param aSessionId ID identifying the session.         

         * @param aMessage containing the service request

         */

        virtual void UpdateRcpNotificationBoundary(

            TUint aSessionId,

            const RMessage2& aMessage );

        /**

         * ConfigureMulticastGroup

         * @since Series 60 3.0

         * @param aSessionId ID identifying the session.         

         * @param aMessage containing the service request

         */

        virtual void ConfigureMulticastGroup(

            TUint aSessionId,

            const RMessage2& aMessage );

        /**

         * Get packet statistics of the current connection.

         *

         * @since S60 v3.2

         * @param aSessionId ID identifying the session.         

         * @param aMessage containing the service request

         */

        void GetPacketStatistics(

            TUint aSessionId,

            const RMessage2& aMessage );

        /**

         * Clear packet statistics of the current connection.

         *

         * @since S60 v3.2

         * @param aSessionId ID identifying the session.         

         * @param aMessage containing the service request

         */        

        void ClearPacketStatistics(

            TUint aSessionId,

            const RMessage2& aMessage );