1 /*

     2 * Copyright (c) 2001-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 the License "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: Declares the main handler, CWiFiProtUiClient and public API for the Wi-Fi Protected Settings. 

    15 *

    16 */

    17 

    18 

    19 #ifndef C_WIFIPROTUICLIENT_H

    20 #define C_WIFIPROTUICLIENT_H

    21 

    22 // INCLUDES

    23 

    24 #include <e32base.h>

    25 #include <wlanmgmtcommon.h>

    26 #include <wifiprotreturn.h>

    27 

    28 // FORWARD DECLARATIONS

    29 class CWiFiProtUiClientImpl;

    30 

    31 // CLASS DECLARATION

    32 /*

    33 * WiFi Protected Setup , used to show the user a sequence of dialogs to setup

    34 * a wlan network automatically

    35 * This class is just a proxy, the real implementation is in

    36 * CWiFiProtUiClientImpl. 

    37 * No details of the actual data are exposed.

    38 */

    39 class CWiFiProtUiClient  : public CBase

    40     {

    41     public: // Constructors and destructor

    42         /**

    43         * Two-phased constructor. Leaves on failure.

    44         * @return The constructed CWiFiProtUiClient object.

    45         */

    46         IMPORT_C static CWiFiProtUiClient* NewL();

    47 

    48         /**

    49         * Destructor.

    50         */

    51         IMPORT_C ~CWiFiProtUiClient();

    52 

    53         // New methods

    54 

    55         /**

    56         * Starts WiFi Protected Setup sequence

    57         * @param aSSid contains SSid of the network we want to configure 

    58         * @param aConnectionNeeded - This parameter is not used anymore in

    59         * the current implementation. It is just there to preserve

    60         * compatibility. Please use StartWiFiProtConnL to configure a

    61         * connection using Wi-Fi Protected Setup.

    62         * @param aUidsReturned uids of the configured connection methods        

    63         * @param aReturnValue - possible return values are ok, cancel

    64         * process and not use protected setup (No Automatic Setup).

    65         * @param aStatus - Request status of the client       

    66         */

    67         IMPORT_C void StartWiFiProtL( const TWlanSsid& aSSid,

    68                                       TBool aConnectionNeeded,

    69                                       RArray<TUint32>& aUidsReturned,

    70                                       WiFiProt::TWiFiReturn& aReturnValue,

    71                                       TRequestStatus& aStatus );

    72 

    73         /**

    74         * Starts WiFi Protected Setup sequence - sync version

    75         * @param aSSid contains SSid of the network we want to configure 

    76         * @param aConnectionNeeded - This parameter is not used anymore in

    77         * the current implementation. It is just there to preserve

    78         * compatibility. Please use StartWiFiProtConnL to configure a

    79         * connection using Wi-Fi Protected Setup.

    80         * @param aUidsReturned uids of the configured connection methods        

    81         * @return  - possible return values are ok, cancel process

    82         * and not use protected setup (No Automatic Setup).

    83         * We can return a value since the call is sychronous.

    84         */

    85         IMPORT_C WiFiProt::TWiFiReturn StartWiFiProtSyncL(

    86                                           const TWlanSsid& aSSid,

    87                                           TBool aConnectionNeeded,

    88                                           RArray<TUint32>& aUidsReturned );

    89 

    90         /**

    91         * Cancels WiFi Protected Setup sequence

    92         */

    93         IMPORT_C void CancelWiFiProt( );

    94         

    95         /**

    96         * Starts WiFi Protected Setup sequence in Connection initiation mode

    97         * (WPS phase 2 implementation)

    98         * @param aSSid contains SSid of the network we want to configure 

    99         * @param aNetworkSettings configuration settings of the network to use

   100         * for the connection (returned as the result of Protected Setup)      

   101         * @param aReturnValue - possible return values are ok, cancel

   102         * process and not use protected setup (No Automatic Setup).

   103         * @param aStatus - Request status of the client       

   104         */

   105         IMPORT_C void StartWiFiProtConnL( const TWlanSsid& aSSid,

   106                                       TWlanProtectedSetupCredentialAttribute&

   107                                         aNetworkSettings,

   108                                       WiFiProt::TWiFiReturn& aReturnValue,

   109                                       TRequestStatus& aStatus );

   110 

   111     private:    // Data 

   112         CWiFiProtUiClientImpl* iImpl;  ///< Implementation. Owned.

   113     };

   114 

   115 #endif //C_WIFIPROTUICLIENT_H

   116 

   117 // End of File