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 * %version: tr1cfwln#6 %

    20 */

    21 

    22 #ifndef C_WIFIPROTUICLIENT_H

    23 #define C_WIFIPROTUICLIENT_H

    24 

    25 // INCLUDES

    26 

    27 #include <e32base.h>

    28 #include <wlanmgmtcommon.h>

    29 #include <wifiprotreturn.h>

    30 

    31 // FORWARD DECLARATIONS

    32 class CWiFiProtUiClientImpl;

    33 

    34 // CLASS DECLARATION

    35 /*

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

    37 * a wlan network automatically

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

    39 * CWiFiProtUiClientImpl. 

    40 * No details of the actual data are exposed.

    41 */

    42 class CWiFiProtUiClient  : public CBase

    43     {

    44     public: // Constructors and destructor

    45         /**

    46         * Two-phased constructor. Leaves on failure.

    47         * @return The constructed CWiFiProtUiClient object.

    48         */

    49         IMPORT_C static CWiFiProtUiClient* NewL();

    50 

    51         /**

    52         * Destructor.

    53         */

    54         IMPORT_C ~CWiFiProtUiClient();

    55 

    56         // New methods

    57 

    58         /**

    59         * Starts WiFi Protected Setup sequence

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

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

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

    63         * compatibility. Please use StartWiFiProtConnL to configure a

    64         * connection using Wi-Fi Protected Setup.

    65         * @param aUidsReturned uids of the configured connection methods        

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

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

    68         * @param aStatus - Request status of the client       

    69         */

    70         IMPORT_C void StartWiFiProtL( const TWlanSsid& aSSid,

    71                                       TBool aConnectionNeeded,

    72                                       RArray<TUint32>& aUidsReturned,

    73                                       WiFiProt::TWiFiReturn& aReturnValue,

    74                                       TRequestStatus& aStatus );

    75 

    76         /**

    77         * Starts WiFi Protected Setup sequence - sync version

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

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

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

    81         * compatibility. Please use StartWiFiProtConnL to configure a

    82         * connection using Wi-Fi Protected Setup.

    83         * @param aUidsReturned uids of the configured connection methods        

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

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

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

    87         */

    88         IMPORT_C WiFiProt::TWiFiReturn StartWiFiProtSyncL(

    89                                           const TWlanSsid& aSSid,

    90                                           TBool aConnectionNeeded,

    91                                           RArray<TUint32>& aUidsReturned );

    92 

    93         /**

    94         * Cancels WiFi Protected Setup sequence

    95         */

    96         IMPORT_C void CancelWiFiProt( );

    97         

    98         /**

    99         * Starts WiFi Protected Setup sequence in Connection initiation mode

   100         * (WPS phase 2 implementation)

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

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

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

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

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

   106         * @param aStatus - Request status of the client       

   107         */

   108         IMPORT_C void StartWiFiProtConnL( const TWlanSsid& aSSid,

   109                                       TWlanProtectedSetupCredentialAttribute&

   110                                         aNetworkSettings,

   111                                       WiFiProt::TWiFiReturn& aReturnValue,

   112                                       TRequestStatus& aStatus );

   113 

   114     private:    // Data 

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

   116     };

   117 

   118 #endif //C_WIFIPROTUICLIENT_H

   119 

   120 // End of File