convergedcallengine/cce/inc/ccceplugin.h
changeset 0 ff3b6d0fd310
child 19 7d48bed6ce0c
equal deleted inserted replaced
-1:000000000000 0:ff3b6d0fd310
       
     1 /*
       
     2 * Copyright (c) 2006-2007 Nokia Corporation and/or its subsidiary(-ies). 
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  Handles plugins 
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef CCCEPLUGIN_H
       
    20 #define CCCEPLUGIN_H
       
    21 
       
    22 #include <e32base.h>
       
    23 
       
    24 #include "mccpcsobserver.h"  // MCCPCSObserver
       
    25 #include "mccpssobserver.h" 
       
    26 
       
    27 class CConvergedCallProvider;
       
    28 class MCCPDTMFProvider;
       
    29 class MCCPDTMFObserver;
       
    30 class MCCPPluginDeathObserver;
       
    31 class CCCPHandle;
       
    32 class CCCECallContainer;
       
    33 class MCCPEmergencyCall;
       
    34 class MCCEObserver;
       
    35 class MCCPCallObserver;
       
    36 class CCCETransferController;
       
    37 class MCCPConferenceCall;
       
    38 
       
    39 /**
       
    40  *  CCE Plugin
       
    41  *
       
    42  *
       
    43  *
       
    44  *  @lib cce.dll
       
    45  *  @since S60 v3.2
       
    46  */
       
    47 NONSHARABLE_CLASS(CCCEPlugin): public CBase,
       
    48                                public MCCPCSObserver,
       
    49                                public MCCPSsObserver
       
    50     {
       
    51 public:
       
    52 
       
    53     /**
       
    54      * Two-phased constructor.
       
    55      * @param aPluginUID Plugin uid for this plugin
       
    56      * @param aObserver Reference to observer
       
    57      * @param aCallContainer Reference to call container
       
    58      * @param aDeathObserver Reference to death observer
       
    59      * @param iTransferController Reference to transfer controller
       
    60      */
       
    61     static CCCEPlugin* NewL( 
       
    62         const TUid& aPluginUID,
       
    63         MCCEObserver& aObserver,
       
    64         CCCECallContainer& aCallContainer,
       
    65         MCCPPluginDeathObserver& aDeathObserver,
       
    66         CCCETransferController& iTransferController );
       
    67 
       
    68     /**
       
    69      * Destructor.
       
    70      */
       
    71     virtual ~CCCEPlugin();
       
    72 
       
    73 public:
       
    74 
       
    75     /**
       
    76      * Returns interface for this plugin.
       
    77      *
       
    78      * @since S60 v3.2
       
    79      * @return Pointer to this plugin.
       
    80      */
       
    81     CConvergedCallProvider* GetPluginL() const;
       
    82 
       
    83     /**
       
    84      * Initializes emergency call for this plugin.
       
    85      *
       
    86      * @since S60 v3.2
       
    87      * @param aEmergencyCallObserver Reference to used observer.
       
    88      */
       
    89     void InitialiseEmergencyCallL( MCCPCallObserver& aEmergencyCallObserver );
       
    90 
       
    91     /**
       
    92      * Gets interface for emergency call.
       
    93      *
       
    94      * @since S60 v3.2
       
    95      * @return Pointer to emergencycall interface.
       
    96      */
       
    97     MCCPEmergencyCall* GetEmergencyCall() const;
       
    98 
       
    99     /**
       
   100      * Gets interface for dtmf handling
       
   101      *
       
   102      * @since S60 v3.2
       
   103      * @param aObserver Reference to used observer.
       
   104      * @return Reference to providers dtmf interface
       
   105      */
       
   106     MCCPDTMFProvider& GetDtmfProviderL(
       
   107         const MCCPDTMFObserver& aObserver );
       
   108 
       
   109     /**
       
   110      * Returns plugin type
       
   111      *
       
   112      * @since S60 v3.2
       
   113      * @return Uid for this plugin.
       
   114      */
       
   115     TUid Type() const;
       
   116     
       
   117    /**
       
   118     * Returns ETrue if plugin can be relesed if idle
       
   119     *
       
   120     * @since S60 v3.2
       
   121     * @return TBool EFalse If plugin is permanently in memory
       
   122     */
       
   123     TBool ReleaseWhenIdle();
       
   124    
       
   125    /**
       
   126     * Returns ETrue if plugin can be relesed if idle
       
   127     *
       
   128     * @since S60 v3.2
       
   129     * @param aReleaseWhenIdle Set EFalse if plugin is permanently in memory
       
   130     */
       
   131     void SetReleaseWhenIdle(TBool aReleaseWhenIdle);
       
   132     
       
   133 private:
       
   134     /**
       
   135      * Checks if call is allowed
       
   136      *
       
   137      * @since S60 v3.2
       
   138      * @return Count of non conference calls
       
   139      * @return Error if call is not allowed
       
   140      */
       
   141     TInt IsCallAllowed() const;
       
   142     
       
   143     /**
       
   144      * Checks if data call can be allowed 
       
   145      *
       
   146      * @since S60 v3.2
       
   147      * @return ETrue if data call can be allowed. 
       
   148      */
       
   149     TBool IsDataCallAllowed() const;
       
   150 
       
   151 // from base class MCCPCSObserver
       
   152 
       
   153     /** @see MCCPCSObserver::PluginInitiatedCSMoCallCreated */
       
   154     void MoCallCreated( MCCPCall& aCall );
       
   155 
       
   156     /** @see MCCPCSObserver::DataPortName */
       
   157 	void DataPortName( TName& aPortName );
       
   158 
       
   159 	/** @see MCCPCSObserver::ConferenceCallCreated */
       
   160 	void ConferenceCallCreated( MCCPConferenceCall& aConferenceCall ); 
       
   161 	
       
   162 // from base class MCCPObserver
       
   163 
       
   164     /** @see MCCPObserver::ErrorOccurred */
       
   165     void ErrorOccurred( TCCPError aError );
       
   166 
       
   167     /** @see MCCPObserver::IncomingCall */
       
   168     void IncomingCall( MCCPCall* aCall, MCCPCall& aTempCall );
       
   169 
       
   170     /** @see MCCPObserver::IncomingCall */
       
   171     void IncomingCall( MCCPCall* aCall );
       
   172 
       
   173     /** @see MCCPObserver::CallCreated */
       
   174     void CallCreated( MCCPCall* aCall, MCCPCall* aOriginator, TBool aAttented );
       
   175 
       
   176 // from base class MCCPObserver
       
   177     
       
   178     /** @see MCCPSsObserver::BarringEventOccurred */
       
   179    	void BarringEventOccurred( const MCCPSsObserver::TCCPSsBarringEvent aBarringEvent );
       
   180 								  
       
   181      /** @see MCCPSsObserver::CLIEventOccurred */
       
   182 	void CLIEventOccurred( const MCCPSsObserver::TCCPSsCLIEvent aCallLineEvent );
       
   183 								  
       
   184      /** @see MCCPSsObserver::CallForwardEventOccurred */
       
   185 	void CallForwardEventOccurred( const MCCPSsObserver::TCCPSsCallForwardEvent aCallForwardEvent,
       
   186         const TDesC& aRemoteAddress );
       
   187 
       
   188     /** @see MCCPSsObserver::CallCugEventOccurred */
       
   189 	void CallCugEventOccurred( const MCCPSsObserver::TCCPSsCugEvent aCugEvent );
       
   190 	
       
   191 	/** @see MCCPSsObserver::NotifyCurrentActiveALSLine */
       
   192 	void NotifyCurrentActiveALSLine( TInt aLine );
       
   193 private:
       
   194 
       
   195     /** Constructor */
       
   196     CCCEPlugin( 
       
   197         const TUid& aPluginUID,
       
   198         MCCEObserver& aObserver,
       
   199         CCCECallContainer& aCallContainer,
       
   200         MCCPPluginDeathObserver& aDeathObserver,
       
   201         CCCETransferController& iTransferController );
       
   202 
       
   203     /** Leaving stuff in constructor */
       
   204     void ConstructL();
       
   205     
       
   206     /**
       
   207      * Tells if cs plugin is used in current call
       
   208      *
       
   209      * @since S60 v3.2
       
   210      * @param aCall Call to be checked
       
   211      * @return ETrue if cs plugin used
       
   212      */
       
   213     TBool IsCsPlugin( MCCPCall& aCall );
       
   214 
       
   215 private: // data
       
   216 
       
   217     /**
       
   218      * Reference to observer
       
   219      */
       
   220     MCCEObserver& iObserver;
       
   221     
       
   222     /**
       
   223      * Reference to call container
       
   224      */
       
   225     CCCECallContainer& iCallContainer;
       
   226     
       
   227     /**
       
   228      * Reference to trasfer controller
       
   229      */
       
   230     CCCETransferController& iTransferController;
       
   231 
       
   232     /**
       
   233      * Reference to dead observer
       
   234      * This will be informed when plugin crashes
       
   235      */
       
   236 	MCCPPluginDeathObserver& iDeathObserver;
       
   237 
       
   238     /**
       
   239      * Use handle to ecom plugin.
       
   240      * Own
       
   241      */
       
   242     CConvergedCallProvider* iPlugin;
       
   243     
       
   244     /**
       
   245      * Dtmf interface for this plugin
       
   246      * Own
       
   247      */
       
   248     MCCPDTMFProvider* iDtmfProvider;
       
   249     
       
   250     /**
       
   251      * Emergency call interface for this plugin
       
   252      * Own
       
   253      */
       
   254     MCCPEmergencyCall*  iEmergencyCall;
       
   255     
       
   256     /**
       
   257      * Plugin uid for this plugin
       
   258      */
       
   259     const TUid iPluginId;
       
   260     
       
   261     /**
       
   262      * This plugin shoild not be Relased even no active calls exists
       
   263      */
       
   264     TBool iReleaseWhenIdle;
       
   265     };
       
   266 
       
   267 #endif // CCCEPLUGIN_H