messagingapp/msgsettings/msginit/inc/cmobilesignalstrengthhandler.h
author hgs
Tue, 14 Sep 2010 12:19:12 +0530
changeset 63 eceabb8c7a12
parent 46 b1f0785c289d
permissions -rw-r--r--
201035_05
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
46
b1f0785c289d 201027_03
hgs
parents:
diff changeset
     1
/*
b1f0785c289d 201027_03
hgs
parents:
diff changeset
     2
* Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
b1f0785c289d 201027_03
hgs
parents:
diff changeset
     3
* All rights reserved.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
b1f0785c289d 201027_03
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
b1f0785c289d 201027_03
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
b1f0785c289d 201027_03
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
b1f0785c289d 201027_03
hgs
parents:
diff changeset
     8
*
b1f0785c289d 201027_03
hgs
parents:
diff changeset
     9
* Initial Contributors:
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    11
*
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    12
* Contributors:
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    13
*
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    14
* Description:   Signal strength handler implementation over telephony API
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    15
*
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    16
*/
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    17
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    18
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    19
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    20
#ifndef MOBILESIGNALSTRENGTHHANDLER_H
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    21
#define MOBILESIGNALSTRENGTHHANDLER_H
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    22
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    23
// INCLUDES
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    24
#include <e32base.h>
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    25
#include <etelmm.h>
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    26
#include "msignalstrengthhandler.h"
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    27
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    28
// FORWARD DECLARATIONS
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    29
class MSignalStrengthObserver;
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    30
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    31
// CLASS DECLARATION
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    32
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    33
/**
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    34
* Class implementing a signal strength handler over the telephony API
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    35
*/
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    36
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    37
class CMobileSignalStrengthHandler : public CActive, public MSignalStrengthHandler
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    38
{
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    39
    public:
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    40
        /**
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    41
         * Two-phased constructor.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    42
         */
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    43
        static CMobileSignalStrengthHandler* NewL( );
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    44
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    45
        /**
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    46
         * Destructor.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    47
         */
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    48
        ~CMobileSignalStrengthHandler();
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    49
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    50
    private:
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    51
        /**
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    52
         * C++ default constructor.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    53
         */
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    54
        CMobileSignalStrengthHandler();
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    55
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    56
        /**
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    57
         * By default Symbian 2nd phase constructor is private.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    58
         */
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    59
        void ConstructL();
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    60
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    61
    public: // from CActive
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    62
        /**
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    63
         * RunL
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    64
         */
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    65
        void RunL();
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    66
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    67
        /**
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    68
         * RunError
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    69
         * @param aError the error returned
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    70
         *  @return error
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    71
         */
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    72
        TInt RunError( TInt aError );
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    73
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    74
        /**
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    75
         * DoCancel
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    76
         */
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    77
        void DoCancel();
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    78
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    79
    public:
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    80
        /**
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    81
         * Returns ETrue if signal observing is supported, EFalse otherwise.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    82
         * @return ETrue if signal observing is supported, EFalse otherwise.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    83
         */
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    84
        TBool ObservingSupported();
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    85
        
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    86
        /**
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    87
         * Returns ETrue if signal strength requests are supported, EFalse otherwise.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    88
         * @return ETrue if signal strength requests are supported, EFalse otherwise.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    89
         */
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    90
        TBool RequestsSupported();
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    91
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    92
        /**
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    93
         * Sets the signal strength observer. May leave with KErrNotSupported
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    94
         * if signal strength observing is not supported.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    95
         * @param aObserver Observer for signal strength. Ownership is not passed.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    96
         */
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    97
        void SetSignalStrengthObserverL( MSignalStrengthObserver* aObserver );
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    98
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    99
        /**
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   100
         * Starts observing the signal strength. May leave with KErrNotSupported
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   101
         * if signal strength observing is not supported.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   102
         */
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   103
        void StartObservingL();
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   104
 
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   105
        /**
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   106
         * Stops the signal strength observing.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   107
         */
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   108
        void StopObservingL();
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   109
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   110
        /**
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   111
         * Returns the current signal strength. May leave with KErrNotSupported
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   112
         * if signal strength requests are not supported.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   113
         * @return The current signal strength.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   114
         */
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   115
        TInt SignalStrengthL();
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   116
        
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   117
        /**
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   118
         * Returns the current bar value. May leave with KErrNotSupported
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   119
         * if bar value requests are not supported.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   120
         * @return The current signal strength.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   121
         */
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   122
        TInt BarValueL();
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   123
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   124
    private: // New methods
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   125
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   126
        /**
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   127
         * Initializes server sessions.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   128
         */
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   129
        void InitializeSessionsL();
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   130
        
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   131
        /**
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   132
         * Updates the current value of the signal strength.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   133
         */
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   134
        void UpdateSignalStrengthL();
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   135
        
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   136
        /**
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   137
         * Notifiers observer about signal strength.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   138
         */
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   139
        void NotifyObserver();
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   140
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   141
    private: 
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   142
    	/**
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   143
         * Pointer to signal strength observer, may be NULL. Also not owned by the instance.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   144
         */
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   145
        MSignalStrengthObserver* iObserver;
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   146
        
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   147
        /**
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   148
         * State variable for observation.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   149
         */
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   150
        TBool iObserving;
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   151
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   152
        /**
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   153
         * Current value of the signal strength.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   154
         */
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   155
        TInt32 iSignalStrength;
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   156
        
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   157
        /**
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   158
         * Network bars value.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   159
         */
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   160
        TInt8 iBars;
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   161
        
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   162
        /**
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   163
         * Mobile phone.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   164
         */
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   165
        RMobilePhone iMobilePhone;
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   166
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   167
        /**
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   168
         * Telephony server session.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   169
         */
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   170
        RTelServer iTelServer;
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   171
};
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   172
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   173
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   174
#endif // MOBILESIGNALSTRENGTHHANDLER_H
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   175
b1f0785c289d 201027_03
hgs
parents:
diff changeset
   176
// End of File