wlanutilities/wlanqtutilities/stubs/wlanscaninfo.h
branchRCL_3
changeset 25 f28ada11abbf
parent 24 63be7eb3fc78
equal deleted inserted replaced
24:63be7eb3fc78 25:f28ada11abbf
     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 WLANSCANINFO_H
       
    19 #define WLANSCANINFO_H
       
    20 
       
    21 // INCLUDES
       
    22 #include <e32def.h>
       
    23 #include <e32base.h>
       
    24 #include <wlanmgmtcommon.h>
       
    25 
       
    26 #include <QSharedPointer>
       
    27 #include "wlanqtutilsap.h"
       
    28 
       
    29 typedef TUint8 TWlanScanInfoFrame;
       
    30 
       
    31 // CLASS DECLARATION
       
    32 class CWlanScanInfo : public CBase
       
    33     {
       
    34     public:  // Methods
       
    35 
       
    36        // Constructors and destructor
       
    37         
       
    38         /**
       
    39          * Static constructor.
       
    40          * @return Pointer to the constructed object.
       
    41          */
       
    42         static CWlanScanInfo* NewL();
       
    43         
       
    44         /**
       
    45          * Destructor.
       
    46          */
       
    47         ~CWlanScanInfo();
       
    48 
       
    49         /**
       
    50          * Find the data of the first access point.
       
    51          * @return Pointer at the beginning of the first access point stored 
       
    52          *         in the scan list. NULL if not any.
       
    53          */
       
    54         const TWlanScanInfoFrame* First();
       
    55 
       
    56         /**
       
    57          * Find the data of the next access point.
       
    58          * @return Pointer at the beginning of the next access point stored
       
    59          *         in the scan list. NULL if not any.
       
    60          */
       
    61         const TWlanScanInfoFrame* Next();
       
    62 
       
    63         /**
       
    64          * Find is there any more unhandled access points.
       
    65          * @return EFalse if there is access points in the list left, 
       
    66          *         ETrue if not.
       
    67          */
       
    68         TBool IsDone() const;
       
    69 
       
    70         /**
       
    71          * Return RX level of the BSS.
       
    72          * @return RX level.
       
    73          */
       
    74         TUint8 RXLevel() const;
       
    75 
       
    76         /**
       
    77          * Return BSSID of the BSS.
       
    78          * @param  aBssid ID of the access point or IBSS network.
       
    79          * @return Pointer to the beginning of the BSSID. Length is always 6 bytes.
       
    80          */
       
    81         void Bssid(
       
    82             TWlanBssid& aBssid ) const;
       
    83 
       
    84         /**
       
    85          * Get capability of the BSS (see IEEE 802.11 section 7.3.1.4.
       
    86          * @return The capability information.
       
    87          */
       
    88         TUint16 Capability() const;
       
    89 
       
    90         /**
       
    91          * Return requested information element.
       
    92          * @param aIE        Id of the requested IE data.
       
    93          * @param aLength    Length of the IE. Zero if IE not found.
       
    94          * @param aData      Pointer to the beginning of the IE data. NULL if IE not found.
       
    95          * @return           General error message.
       
    96          */
       
    97         TInt InformationElement(
       
    98             TUint8 aIE, 
       
    99             TUint8& aLength, 
       
   100             const TUint8** aData );
       
   101 
       
   102         /**
       
   103          * Find whether Wi-Fi Protected Setup is supported.
       
   104          * @return ETrue if AP supports Wi-Fi Protected Setup,
       
   105          *         EFalse if not.
       
   106          */
       
   107         TBool IsProtectedSetupSupported();
       
   108 
       
   109         /**
       
   110          * Get security mode of the BSS.
       
   111          * @return security mode.
       
   112          */
       
   113         TWlanConnectionExtentedSecurityMode ExtendedSecurityMode() const;
       
   114         
       
   115     private: // Data
       
   116 
       
   117         /**
       
   118          * Constructor.
       
   119          */
       
   120         CWlanScanInfo();
       
   121 
       
   122         /**
       
   123          * Returns the currently iterated AP.
       
   124          */
       
   125         QSharedPointer<WlanQtUtilsAp> GetCurrentAp() const;
       
   126         
       
   127     };
       
   128 
       
   129 #endif // WLANSCANINFO_H