/*

* Copyright (c) 2005-2009 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 class for core server

*

*/

/*

*/

#ifndef CORE_SERVER_H

#define CORE_SERVER_H

#include "am_platform_libraries.h"

#include "abs_core_server.h"

#include "abs_core_server_callback.h"

#include "abs_core_driverif.h"

#include "abs_core_driverif_callback.h"

#include "core_operation_base.h"

#include "core_type_list.h"

#include "core_settings.h"

#include "core_connection_data.h"

#include "core_timer_counter_measures.h"

#include "core_scan_list.h"

#include "abs_core_wpx_adaptation.h"

#include "core_operation_handle_bss_lost.h"

#include "core_wlan_eapol_interface.h"

class ScanList;

class abs_core_timer_c;

class abs_wlan_eapol_callback_interface_c;

class abs_core_frame_handler_c;

class abs_core_event_handler_c;

class abs_core_protected_setup_handler_c;

class core_eapol_handler_c;

/**

 * core server class for WLAN management functionality.

 *

 * @lib wlmserversrv.lib

 * @since S60 v3.1

 */

NONSHARABLE_CLASS( core_server_c ) :

    public abs_core_server_c,

    public abs_core_driverif_callback_c

    {

public: 

    /**

     * Constructor.

     *

     * @param callback External service interface.

     * @param drivers Driver interface

     * @param settings Wlan Device Settings

     * @param mac_address MAC address of the device.

     * @param features Bitmask of enabled features.

     */

    core_server_c(

        abs_core_server_callback_c& callback,

        abs_core_driverif_c& drivers,

        const core_device_settings_s& settings,

        const core_mac_address_s& mac_address,

        u32_t features );

    /**

     * Destructor.

     */

    virtual ~core_server_c();

    /**

     * Perform the necessary initialization procedures after construction.

     * 

     * @since S60 v3.1

     * @return An error code if initialization fails, core_error_ok otherwise.

     * @note This method MUST be called after the construction of this object.

     */

    core_error_e init();

    /**

     * Get a reference to device settings.

     *

     * @since S60 v3.1

     * @return Reference to device settings.

     */

    core_device_settings_s& get_device_settings();

    /**

     * Get a reference to core engine settings.

     *

     * @since S60 v3.1

     * @return Reference to core engine settings.

     */   

    core_settings_c& get_core_settings();

    /**

     * Get a reference to connection data.

     *

     * @since S60 v3.1

     * @return Pointer to connection data.

     */   

    core_connection_data_c* get_connection_data();

    /**

     * Get a reference to EAPOL instance.

     *

     * @since S60 v3.1

     * @return Reference to EAPOL instance.

     */   

    core_wlan_eapol_interface_c& get_eapol_instance();

    /**

     * Direct the callbacks from EAPOL to the given handler.

     *

     * @since S60 v3.1

     * @param New handler of EAPOL callbacks.

     */   

    void set_eapol_handler(

        abs_wlan_eapol_callback_interface_c* handler );

    /**

     * Return the device MAC address.

     *

     * @since S60 v3.1

     * @return The device MAC address.

     */        

    core_mac_address_s& own_mac_addr();

    /**

     * Queue the given internal operation. This method should be used

     * when queueing operations from inside other operations.

     *

     * @param operation Operation to be queued.

     * @return core_error_ok if successfully queued, an error otherwise.

     * @note Ownership of the operation instance is transferred immediately

     *       to this method. If there's an error, the instance is automatically

     *       deleted.

     */

    core_error_e queue_int_operation(

        core_operation_base_c* operation );

    /**

     * Queue the given internal operation and run the next operation if

     * no operation is executing.

     *

     * @param operation Operation to be queued.

     * @return core_error_ok if successfully queued, an error otherwise.

     * @note Ownership of the operation instance is transferred immediately

     *       to this method. If there's an error, the instance is automatically

     *       deleted.

     */

    core_error_e queue_int_operation_and_run_next(

        core_operation_base_c* operation );

    /**

     * Check whether WPA counter measures are active.

     *

     * @since S60 v3.1

     * @return Whether WPA counter measures are active.

     */

    bool_t is_cm_active();

    /**

     * Initialize the connection related data structures.

     * @param iap_data The settings used for establishing the connection.

     * @param device_settings Handle to device settings.

     * @since S60 v3.1

     */

    core_error_e init_connection_data(

        const core_iap_data_s& iap_data,

        const core_device_settings_s& device_settings );

    /**

     * Cleans up connection related data structures from core engine

     * @since S60 v3.1

     */

    void clear_connection_data();

    /**

     * Schedule roaming timer.

     *

     * @since S60 v3.1

     * @param delay Expiration time in micro seconds.

     */    

    void schedule_roam_timer(

        u32_t delay );

    /**

     * Cancel the roaming timer.

     *

     * @since S60 v3.1

     */

    void cancel_roam_timer();

    /**

     * Schedule operation timer.     

     *

     * @since S60 v3.1

     * @param delay Expiration time in micro seconds.

     * @note This timer should never be used while running a sub-operation

     *       since it's possible the sub-operation will also try to the use

     *       the same timer.

     */    

    void schedule_operation_timer(

        u32_t delay );

    /**

     * Cancel the operation timer.

     *

     * @since S60 v3.1

     */

    void cancel_operation_timer();

    /**

     * Check whether DHCP timer is active.

     * 

     * @since S60 v5.0

     * @return true_t if timer is active, false_t otherwise.

     */

    bool_t is_dhcp_timer_active();

    /**

     * Schedule the DHCP timer.

     *

     * @since S60 v3.1

     * @param delay Expiration time in micro seconds.

     */    

    void schedule_dhcp_timer(

        u32_t delay );

    /**

     * Cancel the DHCP timer.

     *

     * @since S60 v3.1

     */

    void cancel_dhcp_timer();

    /**

     * Schedule the driver unload timer.

     * 

     * @since S60 v3.1

     * @param delay Expiration time in micro seconds.

     */

    void schedule_unload_timer(

        u32_t delay );

    /**

     * Cancel the driver unload timer.

     *

     * @since S60 v3.1

     */

    void cancel_unload_timer();

    /**

     * Check whether an operation with the given flags is in queue.

     *

     * @param feature_flags Feature flags to check for.

     * @return Whether an operation with the given flags is in queue.

     */

    bool_t is_operation_in_queue_with_flags(

        u32_t feature_flags );

    /**

     * Check whether an operation of the given type is in queue.

     *

     * @param type Type of the operation to search for.

     * @return Whether an operation of the given type is in queue.

     */

    bool_t is_operation_in_queue_with_type(

        u32_t type );

    /**

     * Cancels all the operations in the queue that have

     * the given feature flags enabled. Does not touch

     * the currently executing operation.

     *

     * @since S60 v3.1

     * @param feature_flags Feature flags to check for.

     */    

    void cancel_operations_with_flags(

        u32_t feature_flags );

    /**

     * Cancels all the operations of the given type in the queue.

     * Does not touch the currently executing operation.

     *

     * @since S60 v3.2

     * @param type Operation type to check for.

     */    

    void cancel_operations_with_type(

        u32_t type );

    /**

     * Cancels all the operations in the queue including

     * the currently executing operation.

     *

     * @since S60 v3.2

     * @param is_graceful_cancel Whether cancel should be graceful or forced.     

     */

    void cancel_all_operations(

        bool_t is_graceful_cancel );

    /**

     * Creates an instance of EAPOL if needed.

     *

     * @since S60 v3.1

     * @param mode Operating mode to use.

     * @return true_t if an instance is successfully created or it already exists, false_t otherwise.

     */

    bool_t create_eapol_instance(

        core_eapol_operating_mode_e mode );

    /**

     * Return the current frame handler.

     *

     * @since S60 v3.2

     * @return Pointer to the current frame handler.

     */

    abs_core_frame_handler_c* frame_handler();

    /**

     * Register a handler for received frames.

     *

     * @since S60 v5.0

     * @param handler Pointer to the new handler.

     */

    void register_frame_handler(

        abs_core_frame_handler_c* handler );

    /**

     * Unregister a handler for received frames.

     *

     * @since S60 v5.0

     * @param handler Pointer to the registered handler.

     */

    void unregister_frame_handler(

        abs_core_frame_handler_c* handler );

    /**

     * Return a reference to the scan list.

     *

     * @since S60 v3.1

     * @return A reference to the scan list.

     */

    core_scan_list_c& get_scan_list();

    /**

     * Return the current event handler.

     *

     * @since S60 v3.2

     * @return Pointer to the current event handler.

     */

    abs_core_event_handler_c* event_handler();

    /**

     * Register a handler for received indications.

     *

     * @since S60 v5.0

     * @param handler Pointer to the new handler.

     */

    void register_event_handler(

        abs_core_event_handler_c* handler );

    /**

     * Unregister a handler for received indications.

     *

     * @since S60 v5.0

     * @param handler Pointer to the registered handler.

     */

    void unregister_event_handler(

        abs_core_event_handler_c* handler );

    /**

     * Forces the engine to roam to any available AP.

     * 

     * @since S60 v3.1

     * @param reason Reason to roam.

     */

    void schedule_roam(

        core_operation_handle_bss_lost_c::core_bss_lost_reason_e reason );

    /**

     * Send a management frame.

     *

     * @since S60 v3.2

     * @param frame_type The type of the frame to send.

     * @param frame_length The length of the frame.

     * @param frame_data Pointer to the frame data.

     * @param destination Destination MAC address.

     * @return true_t if frame was successfully sent, false_t otherwise.

     */

    bool_t send_management_frame(

        core_frame_type_e frame_type,

        const u16_t frame_length,

        const u8_t* const frame_data,

        const core_mac_address_s& destination );

    /**

     * Send a data frame.

     *

     * @since S60 v3.2

     * @param ap_data AP data is being sent to.

     * @param frame_type The type of the frame to send.

     * @param frame_length The length of the frame.

     * @param frame_data Pointer to the frame data.

     * @param frame_priority Desired priority of the frame.

     * @param destination Destination MAC address.

     * @param send_unencrypted Whether the frame must be sent unencrypted.    

     * @return true_t if frame was successfully sent, false_t otherwise.

     */

    bool_t send_data_frame(

        const core_ap_data_c& ap_data,

        core_frame_type_e frame_type,

        const u16_t frame_length,

        const u8_t* const frame_data,

        core_access_class_e frame_priority,

        const core_mac_address_s& destination,

        bool_t send_unencrypted = false_t );

    /**

     * Get a reference to WPX adaptation instance.

     *

     * @since S60 v3.1

     * @return Reference to WPX adaptation instance.

     */   

    abs_core_wpx_adaptation_c& get_wpx_adaptation_instance();

    /**

     * Direct the Protected Setup events to the given handler.

     *

     * @since S60 v3.2

     * @param New handler of Protected Setup events.

     */  

    void set_protected_setup_handler(

        abs_core_protected_setup_handler_c* handler );

public: // abs_core_server_c

    /**

     * Connect to a network.

     *

     * @since S60 v3.1

     * @param request_id An unique identification for the request.

     * @param settings The settings used for establishing the connection.

     * @param connect_status contains the error code of connection attempt

     *        on completion

     * @param ssid_list List of possible secondary SSIDs.

     */

    void connect(

        u32_t request_id,

        const core_iap_data_s& settings,

        core_connect_status_e& connect_status,

        core_type_list_c<core_ssid_entry_s>* ssid_list = NULL );

    /**

     * Disconnect an active connection.

     * 

     * @since S60 v3.1

     * @param request_id An unique identification for the request.

     */

    void release(

        u32_t request_id );

    /**

     * Request available networks with the given SSID.

     * 

     * @since S60 v3.1

     * @param request_id An unique identification for the request.

     * @param scan_mode Defines whether active or passive scan is performed.

     * @param scan_ssid Name of the network to scan for.

     * @param scan_channels Channels to scan.

     * @param scan_max_age Maximum age of returned scan results in seconds.     

     * @param scan_data Scan results are stored here.

     * @param is_current_ap_added Whether the current AP needs to be added during an ongoing

     *                            connection if not otherwise found in the scan.

     * @note If the length of the SSID is zero, a broadcast scan is performed.

     */

    void get_scan_result(

        u32_t request_id,

        core_scan_mode_e scan_mode,

        const core_ssid_s& scan_ssid,

        const core_scan_channels_s& scan_channels,

        u8_t scan_max_age,

        ScanList& scan_data,

        bool_t is_current_ap_added = true_t );

    /**

     * Find which iaps from the given list are currently available.

     * @since S60 v3.1

     * @param request_id An unique identification for the request.

     * @param is_active_scan_allowed specifies whether active scanning is allowed.

     * @param iap_data_list containing list of iap data structures.

     * @param iap_ssid_list List of possible secondary SSIDs.

     * @param scan_data contains the scan results

     */

    void get_available_iaps(

        u32_t request_id,

        bool_t is_active_scan_allowed,

        core_type_list_c<core_iap_data_s>& iap_data_list,

        core_type_list_c<core_ssid_entry_s>* iap_ssid_list,

        ScanList& scan_data );

    /**

     * Get the current RCPI value of the connection.

     * 

     * @since S60 v3.1

     * @param request_id An unique identification for the request.

     * @param rcpi Current channel power indicator (RCPI).

     */

    void get_current_rcpi(

        u32_t request_id,

        u32_t& rcpi );

    /**

     * Disable all WLAN activity.