messagingapp/msgsettings/msginit/inc/cmobilesignalstrengthhandler.h
author Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
Wed, 18 Aug 2010 09:45:25 +0300
changeset 52 12db4185673b
permissions -rw-r--r--
Revision: 201031 Kit: 201033

/*
* Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of "Eclipse Public License v1.0"
* which accompanies this distribution, and is available
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description:   Signal strength handler implementation over telephony API
*
*/



#ifndef MOBILESIGNALSTRENGTHHANDLER_H
#define MOBILESIGNALSTRENGTHHANDLER_H

// INCLUDES
#include <e32base.h>
#include <etelmm.h>
#include "msignalstrengthhandler.h"

// FORWARD DECLARATIONS
class MSignalStrengthObserver;

// CLASS DECLARATION

/**
* Class implementing a signal strength handler over the telephony API
*/

class CMobileSignalStrengthHandler : public CActive, public MSignalStrengthHandler
{
    public:
        /**
         * Two-phased constructor.
         */
        static CMobileSignalStrengthHandler* NewL( );

        /**
         * Destructor.
         */
        ~CMobileSignalStrengthHandler();

    private:
        /**
         * C++ default constructor.
         */
        CMobileSignalStrengthHandler();

        /**
         * By default Symbian 2nd phase constructor is private.
         */
        void ConstructL();

    public: // from CActive
        /**
         * RunL
         */
        void RunL();

        /**
         * RunError
         * @param aError the error returned
         *  @return error
         */
        TInt RunError( TInt aError );

        /**
         * DoCancel
         */
        void DoCancel();

    public:
        /**
         * Returns ETrue if signal observing is supported, EFalse otherwise.
         * @return ETrue if signal observing is supported, EFalse otherwise.
         */
        TBool ObservingSupported();
        
        /**
         * Returns ETrue if signal strength requests are supported, EFalse otherwise.
         * @return ETrue if signal strength requests are supported, EFalse otherwise.
         */
        TBool RequestsSupported();

        /**
         * Sets the signal strength observer. May leave with KErrNotSupported
         * if signal strength observing is not supported.
         * @param aObserver Observer for signal strength. Ownership is not passed.
         */
        void SetSignalStrengthObserverL( MSignalStrengthObserver* aObserver );

        /**
         * Starts observing the signal strength. May leave with KErrNotSupported
         * if signal strength observing is not supported.
         */
        void StartObservingL();
 
        /**
         * Stops the signal strength observing.
         */
        void StopObservingL();

        /**
         * Returns the current signal strength. May leave with KErrNotSupported
         * if signal strength requests are not supported.
         * @return The current signal strength.
         */
        TInt SignalStrengthL();
        
        /**
         * Returns the current bar value. May leave with KErrNotSupported
         * if bar value requests are not supported.
         * @return The current signal strength.
         */
        TInt BarValueL();

    private: // New methods

        /**
         * Initializes server sessions.
         */
        void InitializeSessionsL();
        
        /**
         * Updates the current value of the signal strength.
         */
        void UpdateSignalStrengthL();
        
        /**
         * Notifiers observer about signal strength.
         */
        void NotifyObserver();

    private: 
    	/**
         * Pointer to signal strength observer, may be NULL. Also not owned by the instance.
         */
        MSignalStrengthObserver* iObserver;
        
        /**
         * State variable for observation.
         */
        TBool iObserving;

        /**
         * Current value of the signal strength.
         */
        TInt32 iSignalStrength;
        
        /**
         * Network bars value.
         */
        TInt8 iBars;
        
        /**
         * Mobile phone.
         */
        RMobilePhone iMobilePhone;

        /**
         * Telephony server session.
         */
        RTelServer iTelServer;
};


#endif // MOBILESIGNALSTRENGTHHANDLER_H

// End of File