wlanutilities/wlanqtutilities/base/src/wlanqtutils.cpp
changeset 46 2fbd1d709fe7
parent 38 2dc6da6fb431
child 58 301aeb18ae47
equal deleted inserted replaced
45:d9ec2b8c6bad 46:2fbd1d709fe7
    57 {
    57 {
    58 }
    58 }
    59 
    59 
    60 /*!
    60 /*!
    61     Function for requesting a single WLAN scan to be triggered.
    61     Function for requesting a single WLAN scan to be triggered.
    62     Signal wlanScanReady() is emitted when new scan results are available.
    62     
       
    63     Signal wlanScanReady(int) is emitted when new scan results are available.
       
    64     
       
    65     NOTE: Requesting a new scan while there is an ongoing scan (for this
       
    66     WlanQtUtils instance) is not allowed.
    63 */
    67 */
    64 
    68 
    65 void WlanQtUtils::scanWlans()
    69 void WlanQtUtils::scanWlans()
    66 {
    70 {
    67     d_ptr->scanWlans();
    71     d_ptr->scanWlans();
    68 }
    72 }
    69 
    73 
    70 /*!
    74 /*!
    71     Function for requesting a WLAN AP scan to be triggered.
    75     Function for requesting a WLAN AP scan to be triggered.
       
    76     
    72     Signal availableWlanAps() is emitted when new scan results are available.
    77     Signal availableWlanAps() is emitted when new scan results are available.
       
    78     
       
    79     NOTE: Requesting a new scan while there is an ongoing scan (for this
       
    80     WlanQtUtils instance) is not allowed.
    73 */
    81 */
    74 
    82 
    75 void WlanQtUtils::scanWlanAps()
    83 void WlanQtUtils::scanWlanAps()
    76 {
    84 {
    77     d_ptr->scanWlanAps();
    85     d_ptr->scanWlanAps();
    78 }
    86 }
    79 
    87 
    80 /*!
    88 /*!
    81     Function for requesting a direct WLAN scan with given SSID.
    89     Function for requesting a direct WLAN scan with given SSID.
    82 
    90 
    83     Signal wlanScanDirectReady() is emitted when new scan results are
    91     Signal wlanScanDirectReady(int) is emitted when new scan results are
    84     available.
    92     available.
       
    93     
       
    94     NOTE: Requesting a new scan while there is an ongoing scan (for this
       
    95     WlanQtUtils instance) is not allowed.
    85 
    96 
    86     @param [in] ssid Network name to be found
    97     @param [in] ssid Network name to be found
    87 */
    98 */
    88 
    99 
    89 void WlanQtUtils::scanWlanDirect(const QString &ssid)
   100 void WlanQtUtils::scanWlanDirect(const QString &ssid)
    90 {
   101 {
    91     d_ptr->scanWlanDirect(ssid);
   102     d_ptr->scanWlanDirect(ssid);
    92 }
   103 }
    93 
   104 
    94 /*!
   105 /*!
    95     Function for stopping a (possibly) ongoing WLAN scan. No scan result
   106     Function for stopping a (possibly) ongoing WLAN scan.
    96     signal will be sent before a new scan request is made.
   107     This function can also be called when there is no scan in progres.
       
   108     If a scan is actually cancelled, the corresponding scan result signal
       
   109     is sent with ScanStatusCancelled status.
    97 */
   110 */
    98 
   111 
    99 void WlanQtUtils::stopWlanScan()
   112 void WlanQtUtils::stopWlanScan()
   100 {
   113 {
   101     d_ptr->stopWlanScan();
   114     d_ptr->stopWlanScan();
   102 }
   115 }
   103 
   116 
   104 /*!
   117 /*!
   105     Function to request details of available WLAN networks. Can be called 
   118     Function to request details of available WLAN networks. Can be called 
   106     at any time. Calling right after wlanScanReady() signal ensures you get
   119     at any time. Calling right after wlanScanReady(int) signal ensures you get
   107     the most recent results.
   120     the most recent results.
   108 
   121 
   109     @param [out] wlanIapList List of available WLAN IAPs.
   122     @param [out] wlanIapList List of available WLAN IAPs.
   110     @param [out] wlanApList List of unknown WLAN APs.
   123     @param [out] wlanApList List of unknown WLAN APs.
   111 */
   124 */
   118 }
   131 }
   119 
   132 
   120 /*!
   133 /*!
   121     Function to request details of available WLAN networks. This function is
   134     Function to request details of available WLAN networks. This function is
   122     used to get the results that are informed by following signals:
   135     used to get the results that are informed by following signals:
   123     -wlanScanApReady()
   136     -wlanScanApReady(int)
   124     -wlanScanDirectReady()
   137     -wlanScanDirectReady(int)
   125 
   138 
   126     @param [out] wlanApList List of unknown WLAN APs.
   139     @param [out] wlanApList List of unknown WLAN APs.
   127 */
   140 */
   128 
   141 
   129 void WlanQtUtils::availableWlanAps(
   142 void WlanQtUtils::availableWlanAps(