wlanutilities/wlanqtutilities/base/inc/wlanqtutils.h
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 interface.
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
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    18
#ifndef WLANQTUTILS_H
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    19
#define WLANQTUTILS_H
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    20
31
hgs
parents: 19
diff changeset
    21
// System includes
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    22
31
hgs
parents: 19
diff changeset
    23
#include <QObject>
hgs
parents: 19
diff changeset
    24
#include <QScopedPointer>
hgs
parents: 19
diff changeset
    25
#include <QSharedPointer>
hgs
parents: 19
diff changeset
    26
hgs
parents: 19
diff changeset
    27
// User includes
hgs
parents: 19
diff changeset
    28
hgs
parents: 19
diff changeset
    29
// Forward declarations
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    30
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    31
class WlanQtUtilsIap;
31
hgs
parents: 19
diff changeset
    32
class WlanQtUtilsAp;
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    33
class WlanQtUtilsPrivate;
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    34
31
hgs
parents: 19
diff changeset
    35
// External data types
hgs
parents: 19
diff changeset
    36
hgs
parents: 19
diff changeset
    37
// Constants
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    38
31
hgs
parents: 19
diff changeset
    39
//! Library interface export macro
hgs
parents: 19
diff changeset
    40
#ifdef BUILD_WLANQTUTILITIES_DLL
hgs
parents: 19
diff changeset
    41
#define WLANQTUTILS_EXPORT Q_DECL_EXPORT
hgs
parents: 19
diff changeset
    42
#else
hgs
parents: 19
diff changeset
    43
#define WLANQTUTILS_EXPORT Q_DECL_IMPORT
hgs
parents: 19
diff changeset
    44
#endif
hgs
parents: 19
diff changeset
    45
hgs
parents: 19
diff changeset
    46
// Class declaration
hgs
parents: 19
diff changeset
    47
hgs
parents: 19
diff changeset
    48
class WLANQTUTILS_EXPORT WlanQtUtils : public QObject
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
    Q_OBJECT
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    51
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    52
public:
31
hgs
parents: 19
diff changeset
    53
hgs
parents: 19
diff changeset
    54
    // Data types
hgs
parents: 19
diff changeset
    55
hgs
parents: 19
diff changeset
    56
    //! "None" IAP ID value (e.g. for "not found" cases)
hgs
parents: 19
diff changeset
    57
    static const int IapIdNone = -1;
hgs
parents: 19
diff changeset
    58
hgs
parents: 19
diff changeset
    59
    /*!
hgs
parents: 19
diff changeset
    60
        WLAN connection status.
hgs
parents: 19
diff changeset
    61
        Remember to update traces/trace.properties when modifying this enum.
39
hgs
parents: 31
diff changeset
    62
    */
31
hgs
parents: 19
diff changeset
    63
    enum ConnStatus {
hgs
parents: 19
diff changeset
    64
        ConnStatusNone = 0,         //!< Reserved.
hgs
parents: 19
diff changeset
    65
        ConnStatusConnecting,       //!< Connecting.
hgs
parents: 19
diff changeset
    66
        ConnStatusConnected,        //!< Connected.
hgs
parents: 19
diff changeset
    67
        ConnStatusDisconnected      //!< Disconnected.
hgs
parents: 19
diff changeset
    68
    };
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    69
    
39
hgs
parents: 31
diff changeset
    70
    /*!
hgs
parents: 31
diff changeset
    71
        WLAN scan status
hgs
parents: 31
diff changeset
    72
        Remember to update traces/trace.properties when modifying this enum.
hgs
parents: 31
diff changeset
    73
    */
hgs
parents: 31
diff changeset
    74
    enum ScanStatus {
hgs
parents: 31
diff changeset
    75
        ScanStatusOk = 0,           //!< Scan succeeded.
hgs
parents: 31
diff changeset
    76
        ScanStatusCancelled,        //!< Scan was cancelled.
hgs
parents: 31
diff changeset
    77
        ScanStatusError             //!< Scan failed.
hgs
parents: 31
diff changeset
    78
    };
hgs
parents: 31
diff changeset
    79
    
hgs
parents: 31
diff changeset
    80
    /*! 
hgs
parents: 31
diff changeset
    81
        Internet Connectivity Test status.
hgs
parents: 31
diff changeset
    82
        Remember to update traces/trace.properties when modifying this enum.
hgs
parents: 31
diff changeset
    83
    */        
hgs
parents: 31
diff changeset
    84
    enum IctStatus {
hgs
parents: 31
diff changeset
    85
        IctPassed = 0,              //!< Normal ICT passed.
hgs
parents: 31
diff changeset
    86
        IctHotspotPassed,           //!< Hotspot ICT passed.
hgs
parents: 31
diff changeset
    87
        IctCancelled,               //!< ICT was cancelled.
hgs
parents: 31
diff changeset
    88
        IctFailed                   //!< ICT failed.
hgs
parents: 31
diff changeset
    89
    };    
hgs
parents: 31
diff changeset
    90
    
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    91
    WlanQtUtils();
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    92
    
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    93
    ~WlanQtUtils();
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
    94
31
hgs
parents: 19
diff changeset
    95
    void scanWlans();
hgs
parents: 19
diff changeset
    96
    
hgs
parents: 19
diff changeset
    97
    void scanWlanAps();
hgs
parents: 19
diff changeset
    98
   
hgs
parents: 19
diff changeset
    99
    void scanWlanDirect(const QString &ssid);
hgs
parents: 19
diff changeset
   100
hgs
parents: 19
diff changeset
   101
    void stopWlanScan();
hgs
parents: 19
diff changeset
   102
hgs
parents: 19
diff changeset
   103
    void availableWlans(
hgs
parents: 19
diff changeset
   104
        QList< QSharedPointer<WlanQtUtilsIap> > &wlanIapList,
hgs
parents: 19
diff changeset
   105
        QList< QSharedPointer<WlanQtUtilsAp> > &wlanApList) const;
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   106
    
31
hgs
parents: 19
diff changeset
   107
    void availableWlanAps(
hgs
parents: 19
diff changeset
   108
        QList< QSharedPointer<WlanQtUtilsAp> > &wlanApList) const;
hgs
parents: 19
diff changeset
   109
    
hgs
parents: 19
diff changeset
   110
    int createIap(const WlanQtUtilsAp *wlanAp);
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   111
31
hgs
parents: 19
diff changeset
   112
    bool updateIap(int iapId, const WlanQtUtilsAp *wlanAp);
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   113
31
hgs
parents: 19
diff changeset
   114
    void deleteIap(int iapId);
hgs
parents: 19
diff changeset
   115
hgs
parents: 19
diff changeset
   116
    void connectIap(int iapId, bool runIct = false);
hgs
parents: 19
diff changeset
   117
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   118
    void disconnectIap(int iapId);
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   119
31
hgs
parents: 19
diff changeset
   120
    ConnStatus connectionStatus() const;
hgs
parents: 19
diff changeset
   121
    
hgs
parents: 19
diff changeset
   122
    int activeIap() const;
hgs
parents: 19
diff changeset
   123
    
hgs
parents: 19
diff changeset
   124
    QString iapName(int iapId) const;
hgs
parents: 19
diff changeset
   125
hgs
parents: 19
diff changeset
   126
signals:
hgs
parents: 19
diff changeset
   127
hgs
parents: 19
diff changeset
   128
    /*!
39
hgs
parents: 31
diff changeset
   129
        Signal indicating that WLAN scan is complete when scanning
hgs
parents: 31
diff changeset
   130
        is requested with scanWlans() method.
hgs
parents: 31
diff changeset
   131
        
hgs
parents: 31
diff changeset
   132
        @param [in] status Scan status code (ScanStatus).
31
hgs
parents: 19
diff changeset
   133
    */
39
hgs
parents: 31
diff changeset
   134
    void wlanScanReady(int status);
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   135
    
31
hgs
parents: 19
diff changeset
   136
    /*!
39
hgs
parents: 31
diff changeset
   137
        Signal indicating that WLAN scan is complete when scanning
31
hgs
parents: 19
diff changeset
   138
        is requested with scanWlanAps() method.
39
hgs
parents: 31
diff changeset
   139
        
hgs
parents: 31
diff changeset
   140
        @param [in] status Scan status code (ScanStatus).
31
hgs
parents: 19
diff changeset
   141
    */
39
hgs
parents: 31
diff changeset
   142
    void wlanScanApReady(int status);
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   143
    
31
hgs
parents: 19
diff changeset
   144
    /*!
39
hgs
parents: 31
diff changeset
   145
        Signal indicating that WLAN scan is complete when scanning
31
hgs
parents: 19
diff changeset
   146
        is requested with scanWlanDirect() method.
39
hgs
parents: 31
diff changeset
   147
        
hgs
parents: 31
diff changeset
   148
        @param [in] status Scan status code (ScanStatus).
31
hgs
parents: 19
diff changeset
   149
    */
39
hgs
parents: 31
diff changeset
   150
    void wlanScanDirectReady(int status);
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   151
    
31
hgs
parents: 19
diff changeset
   152
    /*!
hgs
parents: 19
diff changeset
   153
        Signal indicating that new WLAN network has been opened. 
hgs
parents: 19
diff changeset
   154
hgs
parents: 19
diff changeset
   155
        @param [in] iapId ID of the opened IAP.
hgs
parents: 19
diff changeset
   156
    */
hgs
parents: 19
diff changeset
   157
    void wlanNetworkOpened(int iapId);
hgs
parents: 19
diff changeset
   158
    
hgs
parents: 19
diff changeset
   159
    /*!
hgs
parents: 19
diff changeset
   160
        Signal indicating that a WLAN network has been closed.
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   161
31
hgs
parents: 19
diff changeset
   162
        @param [in] iapId ID of the closed IAP.
hgs
parents: 19
diff changeset
   163
        @param [in] reason RConnection::Start() error code.
hgs
parents: 19
diff changeset
   164
                           This is the reason of the closure if user requested
hgs
parents: 19
diff changeset
   165
                           connection creation and it failed.
hgs
parents: 19
diff changeset
   166
                           Otherwise KErrNone.
hgs
parents: 19
diff changeset
   167
    */
hgs
parents: 19
diff changeset
   168
    void wlanNetworkClosed(int iapId, int reason);
hgs
parents: 19
diff changeset
   169
hgs
parents: 19
diff changeset
   170
    /*!
hgs
parents: 19
diff changeset
   171
        Signal indicating result of finished ICT run.
hgs
parents: 19
diff changeset
   172
hgs
parents: 19
diff changeset
   173
        @param [in] iapId ID of IAP ICT was run for.
39
hgs
parents: 31
diff changeset
   174
        @param [in] result IctPassed: Normal ICT passed,
hgs
parents: 31
diff changeset
   175
                           IctHotspotPassed: Hotspot ICT passed,
hgs
parents: 31
diff changeset
   176
                           IctCancelled: ICT was cancelled,
hgs
parents: 31
diff changeset
   177
                           IctFailed: ICT failed
31
hgs
parents: 19
diff changeset
   178
    */
39
hgs
parents: 31
diff changeset
   179
    void ictResult(int iapId, int result);
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   180
    
31
hgs
parents: 19
diff changeset
   181
public slots:
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
protected:
hgs
parents: 19
diff changeset
   184
hgs
parents: 19
diff changeset
   185
protected slots:
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   186
31
hgs
parents: 19
diff changeset
   187
private:
hgs
parents: 19
diff changeset
   188
hgs
parents: 19
diff changeset
   189
    Q_DISABLE_COPY(WlanQtUtils)
hgs
parents: 19
diff changeset
   190
hgs
parents: 19
diff changeset
   191
private slots:
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   192
31
hgs
parents: 19
diff changeset
   193
private: // data
hgs
parents: 19
diff changeset
   194
hgs
parents: 19
diff changeset
   195
    //! Pointer to private implementation
hgs
parents: 19
diff changeset
   196
    QScopedPointer<WlanQtUtilsPrivate> d_ptr;
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   197
31
hgs
parents: 19
diff changeset
   198
    // Friend classes
hgs
parents: 19
diff changeset
   199
    
hgs
parents: 19
diff changeset
   200
    // This is defined as a friend class in order to be able to emit public 
hgs
parents: 19
diff changeset
   201
    // signals directly from private implementation code.
19
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   202
    friend class WlanQtUtilsPrivate;
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   203
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   204
    // This is defined as a friend class in order to be able to
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   205
    // call event handlers of wrappers from test code.
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   206
    friend class TestWlanQtUtils;
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   207
};
10810c91db26 Revision: 201011
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff changeset
   208
31
hgs
parents: 19
diff changeset
   209
#endif // WLANQTUTILS_H