1 /*

     2 * Copyright (c) 2010 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 "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:

    15 * WLAN Management API stubbing for WLAN Qt Utilities use in emulator.

    16 */

    17 

    18 #ifndef WLANMGMTCLIENT_H

    19 #define WLANMGMTCLIENT_H

    20 

    21 #include "wlanmgmtcommon.h"

    22 #include "wlanscaninfo.h"

    23 

    24 // CLASS DECLARATION

    25 

    26 class CWlanMgmtClient : public CBase

    27     {

    28     public:  // Methods

    29 

    30         // Constructors and destructor

    31 

    32         /**

    33          * Static constructor.

    34          * @return Pointer to the constructed object.

    35          */

    36         static CWlanMgmtClient* NewL();

    37 

    38         /**

    39          * Destructor.

    40          */

    41         ~CWlanMgmtClient();

    42 

    43         /**

    44          * Perform a broadcast scan and return the detected WLAN networks.

    45          *

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

    47          *                completion contains KErrNone, otherwise one of the

    48          *                system-wide error codes.

    49          * @param aResults Results of the scan.

    50          */

    51         void GetScanResults(

    52             TRequestStatus& aStatus,

    53             CWlanScanInfo& aResults );

    54 

    55         /**

    56          * Perform a direct scan for an SSID and return the detected WLAN networks.

    57          * If the SSID has zero length, a broadcast scan will be done.

    58          *

    59          * @param aSsid name of the WLAN network

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

    61          *                completion contains KErrNone, otherwise one of the

    62          *                system-wide error codes.

    63          * @param aResults Results of the scan.

    64          */

    65         void GetScanResults(

    66             TWlanSsid& aSsid,

    67             TRequestStatus& aStatus,

    68             CWlanScanInfo& aResults );

    69         

    70         /**

    71          * Cancel an outstanding scan request.

    72          */

    73         void CancelGetScanResults();

    74 

    75         /**

    76          * Get the available WLAN IAPs.

    77          *

    78          * @param aCacheLifetime Defines how many seconds old cached results the client

    79          *                       is willing to accept. The valid is range is from 0 to

    80          *                       60 seconds. The value of -1 means the system default will

    81          *                       be used. The aCacheLifetime parameter has a meaning only

    82          *                       when the aMaxDelay parameter is zero.

    83          *                       Value will be changed to the actual value used by the

    84          *                       system.

    85          * @param aMaxDelay Maximum amount of seconds the client is willing to wait for

    86          *                  the availability results. The valid range is from 0 to 1200

    87          *                  seconds or KWlanInfiniteScanDelay. KWlanInfiniteScanDelay

    88          *                  will never cause a scan, but the request will be

    89          *                  completed when any other broadcast scan request is completed.

    90          *                  Value will be changed to the actual value used by the system.

    91          * @param aFilteredResults Whether availability is filtered based on signal strength.

    92          *                  ETrue if filtering is allowed, EFalse if not.

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

    94          *                completion contains KErrNone, otherwise one of the

    95          *                system-wide error codes.

    96          * @param aAvailableIaps Array of IAPs available.

    97          */

    98         void GetAvailableIaps(

    99             TInt& aCacheLifetime,

   100             TUint& aMaxDelay,

   101             TBool aFilteredResults,

   102             TRequestStatus& aStatus,

   103             RArray<TWlanIapAvailabilityData>& aAvailableIaps );

   104 

   105         /**

   106          * Cancel an outstanding IAP availability request.

   107          */

   108         void CancelGetAvailableIaps();

   109         

   110     private: // Data

   111         

   112         CWlanMgmtClient();

   113     };

   114 

   115 #endif // WLANMGMTCLIENT_H