/*

* Copyright (c) 2002-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:  Core functionality for ConnMon.

*

*/

#ifndef CONNMONIAP_H

#define CONNMONIAP_H

#include <es_sock.h>

#include <in_sock.h>

#include <commdb.h>

#include <es_enum.h>

#include <etel.h>

#include <etelmm.h>

#include <etelpckt.h>

#include <pcktcs.h>

#include <rconnmon.h>

#include "ConnMonDef.h"

#include "CWlanSupport.h"

#include "connmondtmnoti.h"

#include "connmontelnoti.h"

class CConnMonIAP;

class CConnUpDownNotifier;

class CProgressNotifier;

class CDataNotifier;

class CNetwStatusNotifier;

class CNetwRegistrationNotifier;

class CBearerNotifier;

class CWcdmaBearerNotifier;

class CModeNotifier;

class CGsmSignalNotifier;

class CBearerAvailabilityNotifier;

class CSubConnUpDownNotifier;

class CActivityNotifier;

class CConnMonServer;

class CDataVolume;

class CCsdFax;

class CPsdFax;

class CWlanSupport;

class CConnMonBearerNotifier;

// Record name for WLAN bearer table

_LIT( KWlanBearerRecordName, "WLANBearer" );

const TInt KPhoneRetryCount = 7;

const TInt KPhoneRetryTimeout = 100000;

const TInt KConnMonSmallBufferLen = 30;

const TInt KBitsInByte = 8;

const TInt KAttributeParameterIndex = 3;

const TInt KMaxConnectionCount = 16;

// Used to track async stop thread status for a connection

enum TConnMonAsyncStopStatus

    {

    EConnMonAsyncStopNotStarted = 0, // Async stop has not been requested

    EConnMonAsyncStopStarted,        // Stop thread is running

    EConnMonStopCompleted            // Connection has been stopped (sync. or async.)

    };

/**

 * TAsyncStopQueueElement

 * Object to hold async. connection stop request related information.

 */

NONSHARABLE_CLASS( TAsyncStopQueueElement )

    {

public:

    TAsyncStopQueueElement( const RMessage2& aMessage );

    /**

     * Add a connection ID to the ID array. Does nothing if the array is already full. 

     */

    void Add( TUint aConnectionId );

public:

    RMessage2 iMessage;             // Client message that will be completed when stop is done.

    TInt iStatus;                   // Error status for the stop operation

    TInt iIdCount;                  // Number of connections to be stopped

    TInt iStopCount;                // Number of stopped connections

    TUint iId[KMaxConnectionCount]; // IDs of connections to be stopped

    };

/**

* TConnInfo

* Connection information record.

*/

class TConnInfo

    {

    public: // Constructors and destructor

        TConnInfo(

                TInt aIapId,

                TInt aNetId,

                TUint aConnectionId,

                TInt aBearer,

                TBearerInfo aBearerInfo );

    public:

        void Reset();

        static TInt Compare( const TConnInfo& aFirst, const TConnInfo& aSecond );

        static TBool MatchId( const TConnInfo& aFirst, const TConnInfo& aSecond );

        static TBool MatchIap( const TConnInfo& aFirst, const TConnInfo& aSecond );

        static TBool MatchBearer( const TConnInfo& aFirst,const TConnInfo& aSecond );

    public: // Data

        // IAP Id

        TUint32 iIapId;

        // Net Id

        TUint32 iNetId;

        // Unique connection id

        TUint iConnectionId;

        // Bearer type

        TInt iBearer;

        // RConnection object that is open and attached

        RConnection* iConnAttach;

        // Connection status notifier

        CProgressNotifier* iProgressNotifier;

        // Downlink data volume notifier

        CDataNotifier* iDLDataNotifier;

        // Uplink data volume notifier

        CDataNotifier* iULDataNotifier;

        // Active object for getting KDownlinkData and KUplinkData

        CDataVolume* iDataVolumeAO;

        // Connection down notifier

        CSubConnUpDownNotifier* iConnDownNotifier;

        // Connection activity notifier

        CActivityNotifier* iActivityNotifier;

        // 0 means that connection is idle

        // 1 means that there is data moving through the connection

        TUint8 iActivity;

        // Bearer info

        TBearerInfo iBearerInfo;

        // BearerInfo/BearerGroup notifier

        CConnMonBearerNotifier* iBearerNotifier;

        // Status flag to track status of possible async. stop request

        TConnMonAsyncStopStatus iAsyncStopStatus;

    };

/**

* CConnMonIAP

*/

NONSHARABLE_CLASS( CConnMonIAP )

        :

        public CBase,

        public MConnMonTelephonyObserver,

        public MConnMonDtmNotifierObserver

    {

    public: // Constructors and destructor

        CConnMonIAP( CConnMonServer* aServer );

        void ConstructL();

        ~CConnMonIAP();

    public: // New methods

        /**

         * Enumerates active connections.

         * @since

         * @param aCount On return, contains the number of the active connection

         * @return KErrNone if successfull, otherwise a system wide error code.

         */

        TInt EnumerateConnections( TUint& aCount );

        /**

         * Enumerates active connections.

         * @since

         * @param aCount On return, contains the number of the active connection

         * @param aEnumInfo On return, contains the enumarated connection ids.

         * @return KErrNone if successfull, otherwise a system wide error code.

         */

        TInt EnumerateConnectionsL( TUint& aCount, CArrayFixFlat<TUint>& aEnumInfo );

        /**

         * Checks if given connection id is valid.

         * @since

         * @param aConnectionId Connection id.

         * @return KErrNone if successfull, otherwise a system wide error code.

         */

        TBool ConnectionExists( const TUint& aConnectionId );

        /**

         * Gets the count of the subconnections.

         * @since

         * @param aConnectionId  Connection id.

         * @param aSubConnectionCount On return, contains the count of the subconnections.

         * @return KErrNone if successfull, otherwise a system wide error code.

         */

        TInt GetConnectionInfo( const TUint& aConnectionId, TUint& aSubConnectionCount );

        /**

         * Gets a TInt attribute.

         * @since

         * @param aMessage Reference to client message.

         * @param aValue On return, contains the value.

         * @return KErrNone if successfull, otherwise a system wide error code.

         */

        TInt GetIntAttributeL( const RMessage2& aMessage, TInt& aValue );

        /**

         * Gets a TUint attribute.

         * @since

         * @param aMessage Reference to client message.

         * @param aValue On return, contains the value.

         * @return KErrNone if successfull, otherwise a system wide error code.

         */

        TInt GetUintAttributeL( const RMessage2& aMessage, TUint& aValue );

        /**

         * Gets a TBool attribute.

         * @since

         * @param aMessage Reference to client message.

         * @param aValue On return, contains the value.

         * @return KErrNone if successfull, otherwise a system wide error code.

         */

        TInt GetBoolAttributeL( const RMessage2& aMessage, TBool& aValue );

        /**

         * Gets a TDes attribute.

         * @since

         * @param aMessage Reference to client message.

         * @param aValue On return, contains the value.

         * @return KErrNone if successfull, otherwise a system wide error code.

         */

        TInt GetStringAttribute( const RMessage2& aMessage, TDes& aValue );

        /**

         * Gets the UIDs of the clients using a connection. UIDs are 0 in WINS.

         * @since

         * @param aConnectionId  Connection id.

         * @param aClientEnum On return, contains the count of the clients and their uids.

         * @return KErrNone if successfull, otherwise a system wide error code.

         */

        TInt GetUids( const TUint aConnectionId, TConnMonClientEnum& aClientEnum );

        /**

         * Sets a TUint attribute.

         * @since

         * @param aMessage Reference to client message.

         * @param aValue Value to be set.

         * @return KErrNone if successfull, otherwise a system wide error code.

         */

        TInt SetUintAttribute( const RMessage2& aMessage, const TUint aValue );

        /**

         * Sets a TBool attribute.

         * @since

         * @param aMessage Reference to client message, containing the attribute information.

         * @return KErrNone if successfull, otherwise a system wide error code.

         */

        TInt SetBoolAttribute( const RMessage2& aMessage );

        /**

         * Stops a connection asynchronously.

         *

         * @param aMessage Reference to client message, containing the attribute information.

         * @return KRequestPending, KErrNone or a system wide error code.

         */

        TInt AsyncConnectionStopL( const RMessage2& aMessage );

        /**

         * Stops all connections asynchronously.

         *

         * @param aMessage Reference to client message, containing the attribute information.

         * @return KRequestPending, KErrNone or a system wide error code.

         */

        TInt AsyncConnectionStopAllL( const RMessage2& aMessage );

        /**

         * Starts a new thread to asynchronously stop a specific connection.

         *

         * @param aIndex Index number of the connection in internal connection array.

         * @return KErrNone if successfull, otherwise a system wide error code.

         */

        TInt StartAsyncStopThreadL( TInt aIndex );

        /**

         * Completes any asynchronous connection stop requests that are ready,

         * and verifies that the connection and its notifiers are cleaned up.

         *

         * @param aConnectionId ID of the connection that was stopped.

         * @param aError Error status for the connection stop operation.

         * @return void.

         */

        void CompleteAsyncStopReqs( const TUint aConnectionId, const TInt aError );

        /**

         * If the stopped connection is still in the connection info array and

         * connection up/down notifier isn't running, removes the obsolete

         * information and notifiers from the connection info array.

         *

         * @param aConnectionId ID of the connection to be cleaned.

         * @return KErrNone if successfull, otherwise a system wide error code.

         */

        TInt CleanupConnectionInfo( const TUint& aConnectionId );

        /**

         * Cancels all asynchronous connection stop request for a specific client.

         *

         * @param aSession Pointer to the session, used for identification.

         * @return void.

         */

        void CancelAsyncStopReqs( CSession2* aSession );

        /**

         * Sets a String attribute.

         * @since

         * @param aMessage Reference to client message.

         * @param aValue Value to be set.

         * @return KErrNone if successfull, otherwise a system wide error code.

         */

        TInt SetStringAttributeL( const RMessage2& aMessage, const TDes& aValue );

        /**

         * Turns notifications ON.

         */

        void ListenL();

        /**

         * Turns notifications OFF.

         * @since

         * @return void

         */

        void CancelListen();

        /**

         * Adds a connection to the global array and starts notifications for it.

         * @since

         * @param aConnection New connection information.

         * @return KErrNone if successfull, otherwise a system wide error code.

         */

        TInt AddConnectionL( TConnInfo& aConnection );

        /**

         * Removes connection from global array and stops notifications.

         * @since

         * @param aConnection Connection information.

         * @return KErrNone if successfull, otherwise a system wide error code.

         */

        TInt RemoveConnection( TConnInfo& aConnection );

        /**

         * Gets a pointer to the RConnection handle.

         * @since

         * @return A pointer to the RConnection handle.

         */

        inline RConnection* Rconnection()

            {

            return &iConnection;

            }

        /**

         * Gets a pointer to the packet service handle.

         * @since

         * @return A pointer to the packet service handle.

         */

        inline const RPacketService* PacketService() const

            {

            return &iPacketService;

            }

        /**

         * Gets a pointer to the WLAN management services.

         * @since

         * @return A pointer to the WLAN management services.

         */

        inline CWlanSupport* WlanSupport()

            {

            return iWlanSupport;

            }

        /**

         * Gets a pointer to the RMobilePhone handle.

         * @since

         * @return A pointer to the iMobilePhone member.

         */

        inline const RMobilePhone* MobilePhone() const

            {

            return &iMobilePhone;

            }

        /**

         * Gets TConnMonNetworkStatus matching ETel network status.

         * @since

         * @param aPacketStatus Packet network status returned by ETel server.

         * @return TConnMonNetworkStatus.

         */

        TInt CalculateNetworkStatus(

                const RPacketService::TStatus& aPacketStatus ) const;

        /**

         * Gets TConnMonNetworkRegistration matching ETel network registration status.

         * @since

         * @param aRegistration Network registration status returned by ETel server.

         * @return TConnMonNetworkRegistration.

         */

        TInt CalculateNetworkRegistration(

                const RMobilePhone::TMobilePhoneRegistrationStatus& aRegistration ) const;

        /**

         * Gets TConnMonNetworkRegistration_v2 matching ETel network registration status.

         * @since

         * @param aRegistration Network registration status returned by ETel server.

         * @return TConnMonNetworkRegistration_v2.

         */

        TInt CalculateNetworkRegistration_v2(

                const RMobilePhone::TMobilePhoneRegistrationStatus& aRegistration ) const;

        /**

         * Tells whether this cell supports EdgeGPRS or GPRS.

         * @since

         * @return ETrue if cell supports Edge, EFalse otherwise.

         */

        TBool IsEdgeCell();

        /**

         * Tells whether this cell supports Hsdpa or WCDMA.

         * @since

         * @return ETrue if cell supports Hsdpa, EFalse otherwise.

         */

        TBool IsHsdpaCell();

        /**

         * Tells whether this cell supports Hsdpa and/or Hsupa.

         * @since MCL 9.1

         * @return EBearerInfoWCDMA if no high speed features detected, or

         * EBearerInfoHSDPA / EBearerInfoHSUPA / EBearerInfoHSxPA.

         */

        TInt HsxpaStatus();

        /**

         * Gets the time when the connection has started.

         * @since

         * @param aConnectionId The connection id.

         * @param aTime On return, contains the starting time of the connection.

         * @return KErrNone if successfull, otherwise a system wide error code.

         */

        TInt GetStartTime( const TUint& aConnectionId, TTime& aTime );

        /**

         * Gets the bearer info for an internal connection.

         * @since

         * @param aConnectionId  Connection id.

         * @param aBearer On return, contains the bearer.

         * @return KErrNone if successfull, otherwise a system wide error code.

         */

        TInt GetBearer(

                const TUint& aConnectionId,

                TInt& aBearer,

                TBearerInfo& aBearerInfo );

        /**

         * Updates activity information to connection array.

         * @since

         * @param aConnectionId The connection id.

         * @param aActivity 0 means idle, 1 means active.

         * @return KErrNone if successfull, otherwise a system wide error code.

         */

        TInt UpdateActivity( const TUint& aConnectionId, const TUint& aActivity );

        /**

         * Checks if subconnection level notifier has already sent connection

         * closed event.

         * @since

         * @param aConnection The connection info. On return, will contain connection id.

         * @return KErrNone if successfull, otherwise a system wide error code.

         */

        TBool GetDeleteNotifyStatus( TConnInfo& aConnection );

        /**

         * Gets a pointer to the activity notifier object for the given connection id.

         * @since

         * @param aConnectionId The connection id.

         * @param aActivityNotifier On return, pointer to the activity notifier.

         * @return KErrNone if successfull, otherwise a system wide error code.

         */

        TInt GetActivityNotifier(

                const TUint& aConnectionId,

                CActivityNotifier** aActivityNotifier );

        /**

         * Gets a pointer to the progress notifier object for the given connection id.

         * @since

         * @param aConnectionId The connection id.

         * @param aProgressNotifier On return, pointer to the progress notifier.

         * @return KErrNone if successfull, otherwise a system wide error code.

         */

        TInt GetProgressNotifier(

                const TUint& aConnectionId,

                CProgressNotifier** aProgressNotifier );

        /**

         * Gets a pointer to the subconnection up/down notifier object for the

         * given connection id.

         * @since

         * @param aConnectionId The connection id.

         * @param aSubConnUpDownNotifier On return, pointer to the subconnection

         * up/down notifier.