bearermanagement/mpm/inc/mpmvpntogglewatcher.h
author hgs
Wed, 27 Oct 2010 17:51:11 +0300
changeset 71 9f263f780e41
parent 41 bbb64eb3bdee
permissions -rw-r--r--
201039_1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
41
hgs
parents:
diff changeset
     1
/*
71
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
     2
* Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
41
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: Listen VPN toggle key changes in central repository.
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
#ifndef MPMVPNTOGGLEWATCHER_H
hgs
parents:
diff changeset
    19
#define MPMVPNTOGGLEWATCHER_H
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
//  INCLUDES
hgs
parents:
diff changeset
    22
#include <e32base.h>
hgs
parents:
diff changeset
    23
hgs
parents:
diff changeset
    24
// FORWARD DECLARATIONS
hgs
parents:
diff changeset
    25
class CRepository;
hgs
parents:
diff changeset
    26
hgs
parents:
diff changeset
    27
// Stop after this many consecutive central repository errors.
hgs
parents:
diff changeset
    28
const TInt KMpmVpnToggleWatcherCenRepErrorThreshold = 80;
hgs
parents:
diff changeset
    29
hgs
parents:
diff changeset
    30
/**
hgs
parents:
diff changeset
    31
* Class that specifies the functions for handling notify messages about
hgs
parents:
diff changeset
    32
* VPN toggle key changes in central repository.
hgs
parents:
diff changeset
    33
*/
hgs
parents:
diff changeset
    34
class MMpmVpnToggleWatcherNotify
hgs
parents:
diff changeset
    35
{
hgs
parents:
diff changeset
    36
public:
71
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
    37
41
hgs
parents:
diff changeset
    38
    /**
hgs
parents:
diff changeset
    39
     * Sets values for VPN toggle after VPN toggle key changes in central
hgs
parents:
diff changeset
    40
     * repository.
hgs
parents:
diff changeset
    41
     * @param aVpnPreferred Informs if VPN connection is preferred
hgs
parents:
diff changeset
    42
     *                      connection
hgs
parents:
diff changeset
    43
     * @param aVpnIapId VPN IAP Id, which is used for VPN connection, when
71
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
    44
     *                  VPN connection is preferred
41
hgs
parents:
diff changeset
    45
     * @param aSnapId SNAP Id SNAP Id, which is used for VPN connection,
hgs
parents:
diff changeset
    46
     *                when VPN connection is preferred
hgs
parents:
diff changeset
    47
     */
hgs
parents:
diff changeset
    48
     virtual void SetVpnToggleValuesL( const TBool aVpnPreferred,
hgs
parents:
diff changeset
    49
                                       const TUint32 aVpnIapId,
hgs
parents:
diff changeset
    50
                                       const TUint32 aSnapId ) = 0;
hgs
parents:
diff changeset
    51
};
hgs
parents:
diff changeset
    52
hgs
parents:
diff changeset
    53
hgs
parents:
diff changeset
    54
/**
hgs
parents:
diff changeset
    55
 *  Class for monitoring VPN toggle key changes in central repository.
hgs
parents:
diff changeset
    56
 *  Follows KMpmVpnToggleCenRepUid key in central repository.
hgs
parents:
diff changeset
    57
 */
hgs
parents:
diff changeset
    58
class CMpmVpnToggleWatcher : public CActive
hgs
parents:
diff changeset
    59
    {
hgs
parents:
diff changeset
    60
public:
hgs
parents:
diff changeset
    61
hgs
parents:
diff changeset
    62
    /**
hgs
parents:
diff changeset
    63
    * Two-phased constructor.
hgs
parents:
diff changeset
    64
    * @param aNotify Handler for notify messages.
71
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
    65
    */
41
hgs
parents:
diff changeset
    66
    static CMpmVpnToggleWatcher* NewL( MMpmVpnToggleWatcherNotify& aNotify );
hgs
parents:
diff changeset
    67
hgs
parents:
diff changeset
    68
    /**
hgs
parents:
diff changeset
    69
    * Destructor.
hgs
parents:
diff changeset
    70
    */
hgs
parents:
diff changeset
    71
    virtual ~CMpmVpnToggleWatcher();
71
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
    72
41
hgs
parents:
diff changeset
    73
    /**
hgs
parents:
diff changeset
    74
     * Call this when you want to start listen event.
hgs
parents:
diff changeset
    75
     */
71
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
    76
    void StartL();
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
    77
41
hgs
parents:
diff changeset
    78
    /**
hgs
parents:
diff changeset
    79
     * Informs if VPN connection is preferred.
hgs
parents:
diff changeset
    80
     * @return True if VPN connection is preferred.
hgs
parents:
diff changeset
    81
     */
hgs
parents:
diff changeset
    82
    TBool IsVpnConnectionPreferred() const;
71
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
    83
41
hgs
parents:
diff changeset
    84
    /**
hgs
parents:
diff changeset
    85
     * Returns VPN IAP Id, which is used for VPN connection, when VPN
hgs
parents:
diff changeset
    86
     * connection is preferred.
hgs
parents:
diff changeset
    87
     * @return VPN IAP Id
hgs
parents:
diff changeset
    88
     */
hgs
parents:
diff changeset
    89
    TUint32 VpnIapId() const;
71
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
    90
41
hgs
parents:
diff changeset
    91
    /**
hgs
parents:
diff changeset
    92
     * Returns SNAP Id, which is used for VPN connection, when VPN
hgs
parents:
diff changeset
    93
     * connection is preferred.
hgs
parents:
diff changeset
    94
     * @return SNAP Id
hgs
parents:
diff changeset
    95
     */
71
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
    96
    TUint32 SnapId() const;
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
    97
41
hgs
parents:
diff changeset
    98
    /**
hgs
parents:
diff changeset
    99
     * Resets VPN toggle values.
71
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
   100
     */
41
hgs
parents:
diff changeset
   101
    void ResetVpnToggleValues();
71
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
   102
41
hgs
parents:
diff changeset
   103
private:
hgs
parents:
diff changeset
   104
hgs
parents:
diff changeset
   105
    CMpmVpnToggleWatcher( MMpmVpnToggleWatcherNotify& aNotify );
hgs
parents:
diff changeset
   106
hgs
parents:
diff changeset
   107
    void ConstructL();
71
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
   108
41
hgs
parents:
diff changeset
   109
    /**
hgs
parents:
diff changeset
   110
     * Request for notifications.
hgs
parents:
diff changeset
   111
     * @return Error value
hgs
parents:
diff changeset
   112
     */
hgs
parents:
diff changeset
   113
    TInt RequestNotifications();
71
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
   114
41
hgs
parents:
diff changeset
   115
    /**
hgs
parents:
diff changeset
   116
     * Gets VPN toggle values.
hgs
parents:
diff changeset
   117
     * @return Error value
hgs
parents:
diff changeset
   118
     */
hgs
parents:
diff changeset
   119
    TInt GetVpnToggleValues();
hgs
parents:
diff changeset
   120
71
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
   121
protected: // from base class CActive
41
hgs
parents:
diff changeset
   122
71
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
   123
    /**
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
   124
     * Active object's RunL.
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
   125
     */
41
hgs
parents:
diff changeset
   126
    void RunL();
hgs
parents:
diff changeset
   127
71
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
   128
    /**
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
   129
     * Handles a leave occurring in RunL.
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
   130
     * @param aError Leave code of RunL method.
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
   131
     * @return KErrNone
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
   132
     */
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
   133
    TInt RunError( TInt aError );
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
   134
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
   135
    /**
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
   136
     * Active object's DoCancel.
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
   137
     */
41
hgs
parents:
diff changeset
   138
    void DoCancel();
71
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
   139
41
hgs
parents:
diff changeset
   140
private: // data
71
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
   141
41
hgs
parents:
diff changeset
   142
    /**
hgs
parents:
diff changeset
   143
     * Central repository handle
hgs
parents:
diff changeset
   144
     * Own.
hgs
parents:
diff changeset
   145
     */
71
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
   146
    CRepository* iRepository;
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
   147
41
hgs
parents:
diff changeset
   148
    /**
hgs
parents:
diff changeset
   149
     * Informs if VPN connection is preferred connection
hgs
parents:
diff changeset
   150
     * Own.
hgs
parents:
diff changeset
   151
     */
hgs
parents:
diff changeset
   152
    TBool iVpnConnectionPreferred;
71
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
   153
41
hgs
parents:
diff changeset
   154
    /**
hgs
parents:
diff changeset
   155
     * VPN IAP Id which is used, when VPN connection is preferred
hgs
parents:
diff changeset
   156
     * Own.
hgs
parents:
diff changeset
   157
     */
hgs
parents:
diff changeset
   158
    TUint32 iVpnIapId;
71
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
   159
41
hgs
parents:
diff changeset
   160
    /**
hgs
parents:
diff changeset
   161
     * SNAP Id which is used, when VPN connection is preferred
hgs
parents:
diff changeset
   162
     * Own.
hgs
parents:
diff changeset
   163
     */
hgs
parents:
diff changeset
   164
    TUint32 iSnapId;
71
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
   165
41
hgs
parents:
diff changeset
   166
    /**
hgs
parents:
diff changeset
   167
     * Error counter.
hgs
parents:
diff changeset
   168
     */
hgs
parents:
diff changeset
   169
    TUint iErrorCounter;
hgs
parents:
diff changeset
   170
hgs
parents:
diff changeset
   171
    /**
hgs
parents:
diff changeset
   172
     * Handler for notify messages.
hgs
parents:
diff changeset
   173
     * Not own.
hgs
parents:
diff changeset
   174
     */
hgs
parents:
diff changeset
   175
    MMpmVpnToggleWatcherNotify& iNotify;
71
9f263f780e41 201039_1
hgs
parents: 41
diff changeset
   176
41
hgs
parents:
diff changeset
   177
    };
hgs
parents:
diff changeset
   178
hgs
parents:
diff changeset
   179
#endif // MPMVPNTOGGLEWATCHER_H