sl@0: // Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // The Implementation of the CServerStartupMgr class which
sl@0: // connects to the Domain manager to keep aware of the current start-up
sl@0: // state and distributes the state changes to the interested MStartupStateObserver
sl@0: // objects.
sl@0: // 
sl@0: //
sl@0: 
sl@0: /**
sl@0:  @internalComponent
sl@0:  @file 
sl@0: */
sl@0:  
sl@0: #include "ServerStartupManager.h"
sl@0: #include "EComServer.h"
sl@0: #include "EComDebug.h"
sl@0: #include "EComPerformance.h"
sl@0: 
sl@0: /**
sl@0: constructor of CServerStartupMgr
sl@0: @param aHierarchyId The Id of the domain hierarchy to connect to.
sl@0: @param aDomainId The Id of the domain to connect to.
sl@0: @param aFs A reference to a connected file server session.
sl@0: */
sl@0:  CServerStartupMgr::CServerStartupMgr(TDmHierarchyId aHierarchyId, TDmDomainId aDomainId, RFs& aFs):
sl@0: #ifdef __ECOM_SERVER_TESTABILITY__
sl@0:  CDmDomainTestHarness(aHierarchyId,aDomainId),
sl@0: #else
sl@0:  CDmDomain(aHierarchyId,aDomainId),
sl@0: #endif
sl@0:  EKFinalStartupState(EStartupStateNonCritical),
sl@0:  iCurrentStartupState(EStartupStateUndefined),
sl@0:  iFs(aFs)
sl@0: 	 {
sl@0: 	 // does nothing.	
sl@0: 	 }
sl@0: 	 
sl@0: 
sl@0: /** 
sl@0: destructor
sl@0: @internalComponent
sl@0: */
sl@0: CServerStartupMgr::~CServerStartupMgr()
sl@0: 	{
sl@0: 	Cancel();
sl@0: 	iObserverList.Reset();
sl@0: 	}
sl@0: 	
sl@0: 
sl@0: /** 
sl@0: Accessor to the current startup state
sl@0: @internalComponent
sl@0: @return the current startup state
sl@0: */
sl@0: TStartupStateIdentifier CServerStartupMgr::CurrentStartupState()
sl@0: 	{
sl@0: 	return iCurrentStartupState;
sl@0: 	}
sl@0: 	
sl@0: /**
sl@0: updates the MStartupStateObserver objects.
sl@0: @internalComponent
sl@0: @param aKnownState the startup state passed into the MStartupStateObserver objects. 
sl@0: */	
sl@0: void CServerStartupMgr::UpdateStateAwareObjectsL(TStartupStateIdentifier aKnownState)
sl@0: 	{
sl@0: 	RECORD_STARTUP_STATE_TIMER_RESULT(aKnownState)
sl@0: 	RECORD_STARTUP_STATE_HEAP_RESULT(aKnownState)
sl@0: 	TInt observerCount=iObserverList.Count();
sl@0: 	for (TInt i = 0; i < observerCount; i++)
sl@0: 		{
sl@0: 		iObserverList[i]->ProcessSSAEventL(aKnownState);
sl@0: 		}
sl@0: 	RECORD_STARTUP_STATE_HEAP_RESULT(aKnownState)
sl@0: 	RECORD_STARTUP_STATE_TIMER_RESULT(aKnownState)
sl@0: 	}
sl@0: 	
sl@0: /** 
sl@0: This method takes a a startup state which can be KSS or USS as a parameter,
sl@0: and returns a ECOM Known Startup State
sl@0: @internalComponent
sl@0: @param aStartupState a startup state which can be KSS or USS.
sl@0: @return an ECOM known startup state
sl@0: */
sl@0: TStartupStateIdentifier CServerStartupMgr::GetKnownStartupState(TDmDomainState aStartupState)
sl@0: 	{
sl@0: 	if(aStartupState >= EStartupStateNonCritical)
sl@0: 		{
sl@0: 		return EStartupStateNonCritical;
sl@0: 		}
sl@0: 	else if(aStartupState >= EStartupStateCriticalDynamic)
sl@0: 		{
sl@0: 		return EStartupStateCriticalDynamic;
sl@0: 		}
sl@0: 	else if(aStartupState >= EStartupStateCriticalStatic)
sl@0: 		{
sl@0: 		return EStartupStateCriticalStatic;
sl@0: 		}
sl@0: 	else
sl@0: 		{
sl@0: 		return EStartupStateUndefined;
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: 	
sl@0: /**
sl@0: Register the MStartupStateObserver object with the CServerStartupMgr.
sl@0: @internalComponent
sl@0: @param aObs the pointer to the MStartupStateObserver object to be registered with CServerStartupMgr.
sl@0: */
sl@0: void CServerStartupMgr::RegisterObserverL(const MStartupStateObserver* aObs)
sl@0: 	{
sl@0: 	User::LeaveIfError(iObserverList.Append(aObs));
sl@0: 	}
sl@0: 	
sl@0: 
sl@0: /**
sl@0: Handle the error if RunL leaves. Panic with the error code
sl@0: @internalComponent
sl@0: @param aError error code generated by the RunL(), not used here.
sl@0: @return KErrNone to avoid CActiveScheduler to panic. 
sl@0: */	
sl@0: TInt CServerStartupMgr::RunError(TInt aError)
sl@0: 	{
sl@0: 	__ECOM_LOG1("ECOM: PANIC in CServerStartupMgr::RunError(), error= %d", aError);
sl@0: 	User::Panic(KEComServerPanicCategory, EEComPanic_CServerStartupMgr_RunError);	
sl@0: 	return KErrNone; // dummy return to stop compiler warnings
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: This method indicates how the CServerStartupMgr interacts with the Domain
sl@0: manager to keep aware of the startup state change, and distribute it to the
sl@0: MStartupStateObserver objects inside ECOM.
sl@0: @internalComponent
sl@0: @pre CServerStartupMgr is fully constructed.
sl@0: */
sl@0: void CServerStartupMgr::InitialiseL(TBool aSsaEnabled)
sl@0: 	{
sl@0: 	if(!aSsaEnabled)
sl@0: 		{
sl@0: 		// it is not SSA, do a full discovery.
sl@0: 		__ECOM_TRACE("ECOM: CServerStartupMgr::InitialiseL(): It is not SSA, do a full discovery");
sl@0: 		UpdateStateAwareObjectsL(EKFinalStartupState);
sl@0: 		iCurrentStartupState = EKFinalStartupState;
sl@0: 		return;	
sl@0: 		}
sl@0: 	// it is SSA.	
sl@0: 	else
sl@0: 		{
sl@0: 		__ECOM_TRACE("---------------------------------------------------");
sl@0: 		__ECOM_TRACE("ECOM: CServerStartupMgr::InitialiseL(): SSA is on.");
sl@0: #ifdef __ECOM_SERVER_TESTABILITY__
sl@0: 		TRAPD(err, CDmDomainTestHarness::ConstructL());
sl@0: #else
sl@0: 		TRAPD(err, CDmDomain::ConstructL());
sl@0: #endif
sl@0: 		if(err!=KErrNone)
sl@0: 			{
sl@0: 			// the ConstructL leaves, then do a full discovery.
sl@0: 			__ECOM_TRACE("ECOM: CServerStartupMgr::InitialiseL(): Can not connect to the Domain Manager, do a full discovery.");
sl@0: 			UpdateStateAwareObjectsL(EKFinalStartupState);
sl@0: 			iCurrentStartupState = EKFinalStartupState;
sl@0: 			return;
sl@0: 			}
sl@0: 		
sl@0: 		//get the state from Domain Manager in case missing any.	
sl@0: #ifdef __ECOM_SERVER_TESTABILITY__
sl@0: 		RequestTransitionNotificationL();
sl@0: #else
sl@0: 		RequestTransitionNotification();
sl@0: #endif
sl@0: 		
sl@0: 		// get the start up state from the Domain Manager.
sl@0: 		TDmDomainState state = GetState();
sl@0: 		
sl@0: 		// either something wrong with the Domain Manager or final state is reached.
sl@0: 		if(state <= EStartupStateUndefined || state >= EStartupStateNonCritical)
sl@0: 			{
sl@0: 			// do a full discovery. Cancel outstanding request.
sl@0: 			UpdateStateAwareObjectsL(EKFinalStartupState);
sl@0: 			iCurrentStartupState = EKFinalStartupState;
sl@0: 			Cancel();
sl@0: 			return;
sl@0: 			}
sl@0: 			
sl@0: 		// get the ECom Known state.
sl@0: 		TStartupStateIdentifier nextKnownState = GetKnownStartupState(state);
sl@0: 	
sl@0: 		
sl@0: 		 //for EStartupStateCriticalStatic or EStartupStateCriticalDynamic.
sl@0: 		if(nextKnownState != EStartupStateUndefined)
sl@0: 			{
sl@0: 			// catch up to the ECOM interested state.
sl@0: 			UpdateStateAwareObjectsL(EStartupStateCriticalStatic);
sl@0: 			}
sl@0: 			
sl@0: 		iCurrentStartupState = nextKnownState;
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /**
sl@0: Executed when the startup state change is done, it does the same thing 
sl@0: as the method InitialiseL() does when SSA is on and the CurrentStartupState is not EStartupStateNonCritical.
sl@0: @internalComponent
sl@0: */
sl@0: void CServerStartupMgr::RunL()
sl@0: 	{
sl@0: 	// Leave if something wrong with the RequestTransitionNotification().
sl@0: 	User::LeaveIfError(iStatus.Int()); //RunError will handle this.
sl@0: 
sl@0: 	//do request transition notification in case missing any.
sl@0: #ifdef __ECOM_SERVER_TESTABILITY__
sl@0: 	RequestTransitionNotificationL();
sl@0: #else
sl@0: 	RequestTransitionNotification();
sl@0: #endif
sl@0: 		
sl@0: 	// get the start up state from Domain Manager.
sl@0: 	TDmDomainState state = GetState();
sl@0: 	//If the state is EStartupStateUndefined there must be sth wrong.
sl@0: 	if(state == EStartupStateUndefined) 
sl@0: 		{
sl@0: #ifdef __ECOM_SERVER_TESTABILITY__
sl@0: 		AcknowledgeLastStateL(KErrBadHandle);
sl@0: #else
sl@0: 		AcknowledgeLastState(KErrBadHandle);
sl@0: #endif
sl@0: 		Cancel();
sl@0: 		User::Leave(KErrBadHandle); //RunError will handle this.
sl@0: 		}
sl@0: 
sl@0: 	//get the known state			
sl@0: 	TStartupStateIdentifier nextKnownState = GetKnownStartupState(state);
sl@0: 
sl@0: 	//If the nextKnownState is a state that we are ready to switch to
sl@0: 	//update all the state aware objects and change the state.
sl@0: 	//This way if we receive a state that is same as our current state
sl@0: 	//we do not process it. Or the new state is less than our current
sl@0: 	//state, we just ignore it.
sl@0: 	if((iCurrentStartupState < EStartupStateCriticalStatic && nextKnownState == EStartupStateCriticalStatic)
sl@0: 	    || (iCurrentStartupState < EStartupStateCriticalDynamic && nextKnownState == EStartupStateCriticalDynamic)
sl@0: 	    || (iCurrentStartupState < EStartupStateNonCritical && nextKnownState == EStartupStateNonCritical))
sl@0: 		{
sl@0: 		UpdateStateAwareObjectsL(nextKnownState);
sl@0: 		iCurrentStartupState = nextKnownState;
sl@0: 		}
sl@0: 		
sl@0: 	//Tell domain manager that we have processed the last state change.
sl@0: #ifdef __ECOM_SERVER_TESTABILITY__
sl@0: 	AcknowledgeLastStateL(KErrNone);
sl@0: #else
sl@0: 	AcknowledgeLastState(KErrNone);
sl@0: #endif
sl@0: 		
sl@0: 	//do not request transition notification if we have reached the last state
sl@0: 	if(nextKnownState == EStartupStateNonCritical)
sl@0: 		{
sl@0: 		Cancel();
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: 
sl@0: 
sl@0: