wlanutilities/wlanqtutilities/base/src/wlanqtutils.cpp
author hgs
Thu, 24 Jun 2010 10:49:51 +0300
changeset 39 7b3e49e4608a
parent 31 e8f4211554fb
child 58 301aeb18ae47
permissions -rw-r--r--
201025
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     1
/*
31
hgs
parents: 19
diff changeset
     2
* Copyright (c) 2009-2010 Nokia Corporation and/or its subsidiary(-ies).
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     3
* All rights reserved.
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     4
* This component and the accompanying materials are made available
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     6
* which accompanies this distribution, and is available
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     8
*
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
     9
* Initial Contributors:
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    11
*
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    12
* Contributors:
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    13
*
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    14
* Description:
31
hgs
parents: 19
diff changeset
    15
* WLAN Qt Utilities implementation.
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    16
*/
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    17
31
hgs
parents: 19
diff changeset
    18
// System includes
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    19
31
hgs
parents: 19
diff changeset
    20
// User includes
hgs
parents: 19
diff changeset
    21
hgs
parents: 19
diff changeset
    22
#include "wlanqtutilsap.h"
hgs
parents: 19
diff changeset
    23
#include "wlanqtutilsiap.h"
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    24
#include "wlanqtutils_p.h"
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    25
#include "wlanqtutils.h"
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    26
31
hgs
parents: 19
diff changeset
    27
/*!
hgs
parents: 19
diff changeset
    28
    \class WlanQtUtils
hgs
parents: 19
diff changeset
    29
    \brief Wlan Qt Utilities. This class provides a Qt API for UI components
hgs
parents: 19
diff changeset
    30
           for retrieving different kind of information related to WLAN
hgs
parents: 19
diff changeset
    31
           functionality.
hgs
parents: 19
diff changeset
    32
*/
hgs
parents: 19
diff changeset
    33
hgs
parents: 19
diff changeset
    34
hgs
parents: 19
diff changeset
    35
// External function prototypes
hgs
parents: 19
diff changeset
    36
hgs
parents: 19
diff changeset
    37
// Local constants
hgs
parents: 19
diff changeset
    38
hgs
parents: 19
diff changeset
    39
// ======== LOCAL FUNCTIONS ========
hgs
parents: 19
diff changeset
    40
hgs
parents: 19
diff changeset
    41
// ======== MEMBER FUNCTIONS ========
hgs
parents: 19
diff changeset
    42
hgs
parents: 19
diff changeset
    43
/*!
hgs
parents: 19
diff changeset
    44
    Constructor.
hgs
parents: 19
diff changeset
    45
*/
hgs
parents: 19
diff changeset
    46
hgs
parents: 19
diff changeset
    47
WlanQtUtils::WlanQtUtils() :
hgs
parents: 19
diff changeset
    48
    d_ptr(new WlanQtUtilsPrivate(this))
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    49
{
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    50
}
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    51
31
hgs
parents: 19
diff changeset
    52
/*!
hgs
parents: 19
diff changeset
    53
    Destructor.
hgs
parents: 19
diff changeset
    54
*/
hgs
parents: 19
diff changeset
    55
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    56
WlanQtUtils::~WlanQtUtils()
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    57
{
31
hgs
parents: 19
diff changeset
    58
}
hgs
parents: 19
diff changeset
    59
hgs
parents: 19
diff changeset
    60
/*!
hgs
parents: 19
diff changeset
    61
    Function for requesting a single WLAN scan to be triggered.
39
hgs
parents: 31
diff changeset
    62
    
hgs
parents: 31
diff changeset
    63
    Signal wlanScanReady(int) is emitted when new scan results are available.
hgs
parents: 31
diff changeset
    64
    
hgs
parents: 31
diff changeset
    65
    NOTE: Requesting a new scan while there is an ongoing scan (for this
hgs
parents: 31
diff changeset
    66
    WlanQtUtils instance) is not allowed.
31
hgs
parents: 19
diff changeset
    67
*/
hgs
parents: 19
diff changeset
    68
hgs
parents: 19
diff changeset
    69
void WlanQtUtils::scanWlans()
hgs
parents: 19
diff changeset
    70
{
hgs
parents: 19
diff changeset
    71
    d_ptr->scanWlans();
hgs
parents: 19
diff changeset
    72
}
hgs
parents: 19
diff changeset
    73
hgs
parents: 19
diff changeset
    74
/*!
hgs
parents: 19
diff changeset
    75
    Function for requesting a WLAN AP scan to be triggered.
39
hgs
parents: 31
diff changeset
    76
    
31
hgs
parents: 19
diff changeset
    77
    Signal availableWlanAps() is emitted when new scan results are available.
39
hgs
parents: 31
diff changeset
    78
    
hgs
parents: 31
diff changeset
    79
    NOTE: Requesting a new scan while there is an ongoing scan (for this
hgs
parents: 31
diff changeset
    80
    WlanQtUtils instance) is not allowed.
31
hgs
parents: 19
diff changeset
    81
*/
hgs
parents: 19
diff changeset
    82
hgs
parents: 19
diff changeset
    83
void WlanQtUtils::scanWlanAps()
hgs
parents: 19
diff changeset
    84
{
hgs
parents: 19
diff changeset
    85
    d_ptr->scanWlanAps();
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    86
}
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    87
31
hgs
parents: 19
diff changeset
    88
/*!
hgs
parents: 19
diff changeset
    89
    Function for requesting a direct WLAN scan with given SSID.
hgs
parents: 19
diff changeset
    90
39
hgs
parents: 31
diff changeset
    91
    Signal wlanScanDirectReady(int) is emitted when new scan results are
31
hgs
parents: 19
diff changeset
    92
    available.
39
hgs
parents: 31
diff changeset
    93
    
hgs
parents: 31
diff changeset
    94
    NOTE: Requesting a new scan while there is an ongoing scan (for this
hgs
parents: 31
diff changeset
    95
    WlanQtUtils instance) is not allowed.
31
hgs
parents: 19
diff changeset
    96
hgs
parents: 19
diff changeset
    97
    @param [in] ssid Network name to be found
hgs
parents: 19
diff changeset
    98
*/
hgs
parents: 19
diff changeset
    99
hgs
parents: 19
diff changeset
   100
void WlanQtUtils::scanWlanDirect(const QString &ssid)
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   101
{
31
hgs
parents: 19
diff changeset
   102
    d_ptr->scanWlanDirect(ssid);
hgs
parents: 19
diff changeset
   103
}
hgs
parents: 19
diff changeset
   104
hgs
parents: 19
diff changeset
   105
/*!
39
hgs
parents: 31
diff changeset
   106
    Function for stopping a (possibly) ongoing WLAN scan.
hgs
parents: 31
diff changeset
   107
    This function can also be called when there is no scan in progres.
hgs
parents: 31
diff changeset
   108
    If a scan is actually cancelled, the corresponding scan result signal
hgs
parents: 31
diff changeset
   109
    is sent with ScanStatusCancelled status.
31
hgs
parents: 19
diff changeset
   110
*/
hgs
parents: 19
diff changeset
   111
hgs
parents: 19
diff changeset
   112
void WlanQtUtils::stopWlanScan()
hgs
parents: 19
diff changeset
   113
{
hgs
parents: 19
diff changeset
   114
    d_ptr->stopWlanScan();
hgs
parents: 19
diff changeset
   115
}
hgs
parents: 19
diff changeset
   116
hgs
parents: 19
diff changeset
   117
/*!
hgs
parents: 19
diff changeset
   118
    Function to request details of available WLAN networks. Can be called 
39
hgs
parents: 31
diff changeset
   119
    at any time. Calling right after wlanScanReady(int) signal ensures you get
31
hgs
parents: 19
diff changeset
   120
    the most recent results.
hgs
parents: 19
diff changeset
   121
hgs
parents: 19
diff changeset
   122
    @param [out] wlanIapList List of available WLAN IAPs.
hgs
parents: 19
diff changeset
   123
    @param [out] wlanApList List of unknown WLAN APs.
hgs
parents: 19
diff changeset
   124
*/
hgs
parents: 19
diff changeset
   125
hgs
parents: 19
diff changeset
   126
void WlanQtUtils::availableWlans(
hgs
parents: 19
diff changeset
   127
    QList< QSharedPointer<WlanQtUtilsIap> > &wlanIapList,
hgs
parents: 19
diff changeset
   128
    QList< QSharedPointer<WlanQtUtilsAp> > &wlanApList) const
hgs
parents: 19
diff changeset
   129
{
hgs
parents: 19
diff changeset
   130
    d_ptr->availableWlans(wlanIapList, wlanApList);
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   131
}
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   132
31
hgs
parents: 19
diff changeset
   133
/*!
hgs
parents: 19
diff changeset
   134
    Function to request details of available WLAN networks. This function is
hgs
parents: 19
diff changeset
   135
    used to get the results that are informed by following signals:
39
hgs
parents: 31
diff changeset
   136
    -wlanScanApReady(int)
hgs
parents: 31
diff changeset
   137
    -wlanScanDirectReady(int)
31
hgs
parents: 19
diff changeset
   138
hgs
parents: 19
diff changeset
   139
    @param [out] wlanApList List of unknown WLAN APs.
hgs
parents: 19
diff changeset
   140
*/
hgs
parents: 19
diff changeset
   141
hgs
parents: 19
diff changeset
   142
void WlanQtUtils::availableWlanAps(
hgs
parents: 19
diff changeset
   143
    QList< QSharedPointer<WlanQtUtilsAp> > &wlanApList) const
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   144
{
31
hgs
parents: 19
diff changeset
   145
    d_ptr->availableWlanAps(wlanApList);
hgs
parents: 19
diff changeset
   146
}
hgs
parents: 19
diff changeset
   147
hgs
parents: 19
diff changeset
   148
/*!
hgs
parents: 19
diff changeset
   149
    Function to create an IAP from the given WLAN access point.
hgs
parents: 19
diff changeset
   150
hgs
parents: 19
diff changeset
   151
    @param [in] wlanAp Access point containing parameters to include in the new IAP.
hgs
parents: 19
diff changeset
   152
    
hgs
parents: 19
diff changeset
   153
    @return IAP ID if creation succeeds, IapIdNone otherwise.
hgs
parents: 19
diff changeset
   154
*/
hgs
parents: 19
diff changeset
   155
hgs
parents: 19
diff changeset
   156
int WlanQtUtils::createIap(const WlanQtUtilsAp *wlanAp)
hgs
parents: 19
diff changeset
   157
{
hgs
parents: 19
diff changeset
   158
    return d_ptr->createIap(wlanAp);
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   159
}
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   160
31
hgs
parents: 19
diff changeset
   161
/*!
hgs
parents: 19
diff changeset
   162
    Function to update an IAP from the given WLAN access point.
hgs
parents: 19
diff changeset
   163
hgs
parents: 19
diff changeset
   164
    @param [in] iapId ID of the IAP to be updated.
hgs
parents: 19
diff changeset
   165
    @param [in] wlanAp Access point containing parameters to update in the IAP.
hgs
parents: 19
diff changeset
   166
    
hgs
parents: 19
diff changeset
   167
    @return Was update successful?
hgs
parents: 19
diff changeset
   168
*/
hgs
parents: 19
diff changeset
   169
hgs
parents: 19
diff changeset
   170
bool WlanQtUtils::updateIap(int iapId, const WlanQtUtilsAp *wlanAp)
hgs
parents: 19
diff changeset
   171
{
hgs
parents: 19
diff changeset
   172
    return d_ptr->updateIap(iapId, wlanAp);
hgs
parents: 19
diff changeset
   173
}
hgs
parents: 19
diff changeset
   174
hgs
parents: 19
diff changeset
   175
/*!
hgs
parents: 19
diff changeset
   176
    Function to delete an IAP.
hgs
parents: 19
diff changeset
   177
hgs
parents: 19
diff changeset
   178
    @param [in] iapId ID of the IAP to be deleted.
hgs
parents: 19
diff changeset
   179
*/
hgs
parents: 19
diff changeset
   180
hgs
parents: 19
diff changeset
   181
void WlanQtUtils::deleteIap(int iapId)
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   182
{
31
hgs
parents: 19
diff changeset
   183
    d_ptr->deleteIap(iapId);
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   184
}
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   185
31
hgs
parents: 19
diff changeset
   186
/*!
hgs
parents: 19
diff changeset
   187
    Function to start connection creation for the given IAP. Runs also
hgs
parents: 19
diff changeset
   188
    Internet Connectivity Test (ICT), if requested with the optional
hgs
parents: 19
diff changeset
   189
    parameter.
hgs
parents: 19
diff changeset
   190
    
hgs
parents: 19
diff changeset
   191
    Connecting while there is already a connection is also supported.
hgs
parents: 19
diff changeset
   192
hgs
parents: 19
diff changeset
   193
    wlanNetworkOpened() or wlanNetworkClosed() signal will be emitted
hgs
parents: 19
diff changeset
   194
    when connection status changes.
hgs
parents: 19
diff changeset
   195
    
hgs
parents: 19
diff changeset
   196
    ictResult() signal will be emitted when (possible) ICT result is
hgs
parents: 19
diff changeset
   197
    available.
hgs
parents: 19
diff changeset
   198
hgs
parents: 19
diff changeset
   199
    @param [in] iapId ID of the IAP to be connected.
hgs
parents: 19
diff changeset
   200
    @param [in] runIct Should ICT be run or not?
hgs
parents: 19
diff changeset
   201
*/
hgs
parents: 19
diff changeset
   202
hgs
parents: 19
diff changeset
   203
void WlanQtUtils::connectIap(int iapId, bool runIct)
hgs
parents: 19
diff changeset
   204
{
hgs
parents: 19
diff changeset
   205
    d_ptr->connectIap(iapId, runIct);
hgs
parents: 19
diff changeset
   206
}
hgs
parents: 19
diff changeset
   207
hgs
parents: 19
diff changeset
   208
/*!
hgs
parents: 19
diff changeset
   209
    Function to disconnect the given IAP.
hgs
parents: 19
diff changeset
   210
    Disconnecting when there is no connection is also supported.
hgs
parents: 19
diff changeset
   211
hgs
parents: 19
diff changeset
   212
    @param [in] iapId ID of the IAP to be disconnected.
hgs
parents: 19
diff changeset
   213
*/
hgs
parents: 19
diff changeset
   214
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   215
void WlanQtUtils::disconnectIap(int iapId)
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   216
{
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   217
    d_ptr->disconnectIap(iapId);
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   218
}
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   219
31
hgs
parents: 19
diff changeset
   220
/*!
hgs
parents: 19
diff changeset
   221
    Function to retrieve the name of the IAP with the given ID.
hgs
parents: 19
diff changeset
   222
hgs
parents: 19
diff changeset
   223
    @param [in] iapId ID of the requested IAP.
hgs
parents: 19
diff changeset
   224
    
hgs
parents: 19
diff changeset
   225
    @return Name of the IAP or empty QString if IAP is not found.
hgs
parents: 19
diff changeset
   226
*/
hgs
parents: 19
diff changeset
   227
hgs
parents: 19
diff changeset
   228
QString WlanQtUtils::iapName(int iapId) const
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   229
{
31
hgs
parents: 19
diff changeset
   230
    return d_ptr->iapName(iapId);
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   231
}
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   232
31
hgs
parents: 19
diff changeset
   233
/*!
hgs
parents: 19
diff changeset
   234
    Connection status getter.
hgs
parents: 19
diff changeset
   235
    
hgs
parents: 19
diff changeset
   236
    @return Current WLAN connection status. 
hgs
parents: 19
diff changeset
   237
*/
hgs
parents: 19
diff changeset
   238
hgs
parents: 19
diff changeset
   239
WlanQtUtils::ConnStatus WlanQtUtils::connectionStatus() const
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   240
{
31
hgs
parents: 19
diff changeset
   241
    return d_ptr->connectionStatus();
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   242
}
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   243
31
hgs
parents: 19
diff changeset
   244
/*!
hgs
parents: 19
diff changeset
   245
    Function for getting the ID of the (possibly) active WLAN IAP.
hgs
parents: 19
diff changeset
   246
    Active here means non-disconnected.
hgs
parents: 19
diff changeset
   247
    Use connectionStatus() for retrieving the actual status.
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   248
31
hgs
parents: 19
diff changeset
   249
    @return ID of the active IAP, IapIdNone if not valid.
hgs
parents: 19
diff changeset
   250
*/
hgs
parents: 19
diff changeset
   251
hgs
parents: 19
diff changeset
   252
int WlanQtUtils::activeIap() const
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   253
{
31
hgs
parents: 19
diff changeset
   254
    return d_ptr->activeIap();
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   255
}