wlanutilities/wlanqtutilities/tsrc/stubs/wlanmgmtclient.h
author hgs
Mon, 23 Aug 2010 13:30:09 +0300
changeset 53 bdc64aa9b954
parent 39 7b3e49e4608a
permissions -rw-r--r--
201033
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
39
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:
hgs
parents:
diff changeset
    15
* WLAN Management API stubbing for WLAN Qt Utilities.
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
#ifndef WLANMGMTCLIENT_H
hgs
parents:
diff changeset
    19
#define WLANMGMTCLIENT_H
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
#include "wlanmgmtcommon.h"
hgs
parents:
diff changeset
    22
#include "wlanscaninfo.h"
hgs
parents:
diff changeset
    23
hgs
parents:
diff changeset
    24
// CLASS DECLARATION
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
class CWlanMgmtClient : public CBase
hgs
parents:
diff changeset
    27
    {
hgs
parents:
diff changeset
    28
    public:  // Methods
hgs
parents:
diff changeset
    29
hgs
parents:
diff changeset
    30
        // Constructors and destructor
hgs
parents:
diff changeset
    31
hgs
parents:
diff changeset
    32
        /**
hgs
parents:
diff changeset
    33
         * Static constructor.
hgs
parents:
diff changeset
    34
         * @return Pointer to the constructed object.
hgs
parents:
diff changeset
    35
         */
hgs
parents:
diff changeset
    36
        static CWlanMgmtClient* NewL();
hgs
parents:
diff changeset
    37
hgs
parents:
diff changeset
    38
        /**
hgs
parents:
diff changeset
    39
         * Destructor.
hgs
parents:
diff changeset
    40
         */
hgs
parents:
diff changeset
    41
        ~CWlanMgmtClient();
hgs
parents:
diff changeset
    42
hgs
parents:
diff changeset
    43
        /**
hgs
parents:
diff changeset
    44
         * Perform a broadcast scan and return the detected WLAN networks.
hgs
parents:
diff changeset
    45
         *
hgs
parents:
diff changeset
    46
         * @param aStatus Status of the calling active object. On successful
hgs
parents:
diff changeset
    47
         *                completion contains KErrNone, otherwise one of the
hgs
parents:
diff changeset
    48
         *                system-wide error codes.
hgs
parents:
diff changeset
    49
         * @param aResults Results of the scan.
hgs
parents:
diff changeset
    50
         */
hgs
parents:
diff changeset
    51
        void GetScanResults(
hgs
parents:
diff changeset
    52
            TRequestStatus& aStatus,
hgs
parents:
diff changeset
    53
            CWlanScanInfo& aResults );
hgs
parents:
diff changeset
    54
hgs
parents:
diff changeset
    55
        /**
hgs
parents:
diff changeset
    56
         * Perform a direct scan for an SSID and return the detected WLAN networks.
hgs
parents:
diff changeset
    57
         * If the SSID has zero length, a broadcast scan will be done.
hgs
parents:
diff changeset
    58
         *
hgs
parents:
diff changeset
    59
         * @param aSsid name of the WLAN network
hgs
parents:
diff changeset
    60
         * @param aStatus Status of the calling active object. On successful
hgs
parents:
diff changeset
    61
         *                completion contains KErrNone, otherwise one of the
hgs
parents:
diff changeset
    62
         *                system-wide error codes.
hgs
parents:
diff changeset
    63
         * @param aResults Results of the scan.
hgs
parents:
diff changeset
    64
         */
hgs
parents:
diff changeset
    65
        void GetScanResults(
hgs
parents:
diff changeset
    66
            TWlanSsid& aSsid,
hgs
parents:
diff changeset
    67
            TRequestStatus& aStatus,
hgs
parents:
diff changeset
    68
            CWlanScanInfo& aResults );
hgs
parents:
diff changeset
    69
        
hgs
parents:
diff changeset
    70
        /**
hgs
parents:
diff changeset
    71
         * Cancel an outstanding scan request.
hgs
parents:
diff changeset
    72
         */
hgs
parents:
diff changeset
    73
        void CancelGetScanResults();
53
hgs
parents: 39
diff changeset
    74
hgs
parents: 39
diff changeset
    75
        /**
hgs
parents: 39
diff changeset
    76
         * Get the available WLAN IAPs.
hgs
parents: 39
diff changeset
    77
         *
hgs
parents: 39
diff changeset
    78
         * @param aCacheLifetime Defines how many seconds old cached results the client
hgs
parents: 39
diff changeset
    79
         *                       is willing to accept. The valid is range is from 0 to
hgs
parents: 39
diff changeset
    80
         *                       60 seconds. The value of -1 means the system default will
hgs
parents: 39
diff changeset
    81
         *                       be used. The aCacheLifetime parameter has a meaning only
hgs
parents: 39
diff changeset
    82
         *                       when the aMaxDelay parameter is zero.
hgs
parents: 39
diff changeset
    83
         *                       Value will be changed to the actual value used by the
hgs
parents: 39
diff changeset
    84
         *                       system.
hgs
parents: 39
diff changeset
    85
         * @param aMaxDelay Maximum amount of seconds the client is willing to wait for
hgs
parents: 39
diff changeset
    86
         *                  the availability results. The valid range is from 0 to 1200
hgs
parents: 39
diff changeset
    87
         *                  seconds or KWlanInfiniteScanDelay. KWlanInfiniteScanDelay
hgs
parents: 39
diff changeset
    88
         *                  will never cause a scan, but the request will be
hgs
parents: 39
diff changeset
    89
         *                  completed when any other broadcast scan request is completed.
hgs
parents: 39
diff changeset
    90
         *                  Value will be changed to the actual value used by the system.
hgs
parents: 39
diff changeset
    91
         * @param aFilteredResults Whether availability is filtered based on signal strength.
hgs
parents: 39
diff changeset
    92
         *                  ETrue if filtering is allowed, EFalse if not.
hgs
parents: 39
diff changeset
    93
         * @param aStatus Status of the calling active object. On successful
hgs
parents: 39
diff changeset
    94
         *                completion contains KErrNone, otherwise one of the
hgs
parents: 39
diff changeset
    95
         *                system-wide error codes.
hgs
parents: 39
diff changeset
    96
         * @param aAvailableIaps Array of IAPs available.
hgs
parents: 39
diff changeset
    97
         */
hgs
parents: 39
diff changeset
    98
        void GetAvailableIaps(
hgs
parents: 39
diff changeset
    99
            TInt& aCacheLifetime,
hgs
parents: 39
diff changeset
   100
            TUint& aMaxDelay,
hgs
parents: 39
diff changeset
   101
            TBool aFilteredResults,
hgs
parents: 39
diff changeset
   102
            TRequestStatus& aStatus,
hgs
parents: 39
diff changeset
   103
            RArray<TWlanIapAvailabilityData>& aAvailableIaps );
hgs
parents: 39
diff changeset
   104
hgs
parents: 39
diff changeset
   105
        /**
hgs
parents: 39
diff changeset
   106
         * Cancel an outstanding IAP availability request.
hgs
parents: 39
diff changeset
   107
         */
hgs
parents: 39
diff changeset
   108
        void CancelGetAvailableIaps();
39
hgs
parents:
diff changeset
   109
        
hgs
parents:
diff changeset
   110
    private: // Data
hgs
parents:
diff changeset
   111
        
hgs
parents:
diff changeset
   112
        CWlanMgmtClient();
hgs
parents:
diff changeset
   113
    };
hgs
parents:
diff changeset
   114
hgs
parents:
diff changeset
   115
#endif // WLANMGMTCLIENT_H