sl@0: // Copyright (c) 2007-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: //
sl@0: 
sl@0: #ifndef MMRCSERVERCONTROLLER_H__
sl@0: #define MMRCSERVERCONTROLLER_H__
sl@0: 
sl@0: #include <e32std.h>
sl@0: #include <e32base.h>
sl@0: #include <a3f/a3fbase.h>
sl@0: #include "mmrcclientserver.h"
sl@0: 
sl@0: class CMMRCServerInfo;
sl@0: class MMMRCServerInfoState;
sl@0: class CMMRCServerSession;
sl@0: class CMMRCServerRuleManager;
sl@0: class CARNNotificationObject;
sl@0: 
sl@0: 
sl@0: /**
sl@0: Panic category and codes that MMRCServerController raises on the client
sl@0: */
sl@0: _LIT(KMMRCServerControllerPanicCategory, "MMRCServerController");
sl@0: 
sl@0: enum TMMRCServerControllerPanicCodes
sl@0: 	{
sl@0: 	EProcessNextRequestLeft = 1,
sl@0: 	EPushPauseContextLeft,
sl@0: 	EPushAllocatedResourceContextFailed
sl@0: 	};
sl@0: 
sl@0: 
sl@0: /**
sl@0: @internalComponent
sl@0: 
sl@0: This class implements the MMRC Server Controller. 
sl@0: The main purpose of this class is to control the different transactions
sl@0: */	
sl@0: NONSHARABLE_CLASS( CMMRCServerController ): public CBase
sl@0: 	{
sl@0: public:
sl@0: 	/**
sl@0: 	 * Constructs, and returns a pointer to, a new CMMRCServerController object.
sl@0: 	 * Leaves on failure.
sl@0: 	 * @return CMMRCServerController* A pointer to newly created utlitly object.
sl@0: 	 */		
sl@0: 	static CMMRCServerController* NewL(); 
sl@0: 	
sl@0: 	/**
sl@0: 	 * Constructs, leaves object on the cleanup stack, and returns a pointer
sl@0: 	 * to, a new CMMRCServerController object.
sl@0: 	 * Leaves on failure.
sl@0: 	 * @return CMMRCServerController* A pointer to newly created utlitly object.
sl@0: 	 */	
sl@0: 	static CMMRCServerController* NewLC();
sl@0: 	
sl@0: 	/**
sl@0: 	 * Destructor.
sl@0: 	 */
sl@0: 	~CMMRCServerController();
sl@0: 	
sl@0: public:
sl@0: 
sl@0: 	/**
sl@0: 	 * Process the request pointer by a specific session
sl@0: 	 * @param CMMRCServerSession& aServerSession
sl@0: 	 * @return KerrNone in case of success of the process
sl@0: 	 */
sl@0: 	TInt EnqueueRequestL(CMMRCServerSession& aServerSession );
sl@0: 	
sl@0: 	/** 
sl@0: 	 * Callback from the adaptation
sl@0: 	 * @param MLogicalChain* aOldChain
sl@0: 	 * @param MLogicalChain* aNewChain
sl@0: 	 * @param TMMRCAdaptationToServerRequestResults aResult
sl@0: 	 */
sl@0: 	void AdaptationRequestAcknowledgment(CMMRCServerSession& aServerSessionAllocatedResource, TMMRCAdaptationToServerRequestResults aResult, TInt aError);
sl@0: 	
sl@0: 	/*
sl@0: 	 * 
sl@0: 	 */
sl@0: 	void CloseSessionByContextId(TInt32 aContextId);
sl@0: 	
sl@0: 	/*
sl@0: 	 * 
sl@0: 	 */
sl@0: 	void ClientAcknowledgment(CMMRCServerSession& aServerSession);
sl@0: 	
sl@0: 	/*
sl@0: 	 * 
sl@0: 	 */
sl@0: 	void ServerState(TMMRCServerState& aServerState, TUint64& aContextId) const;
sl@0: 	
sl@0: 	/**
sl@0: 	 * 
sl@0: 	 * @param CMMRCServerSession& aServerSession
sl@0: 	 * @return KerrNone in case of success of the process
sl@0: 	 */	
sl@0: 	TInt EnqueueRequestForAPRL(CMMRCServerSession& aServerSession );
sl@0: 	
sl@0: 	/**
sl@0: 	 * 
sl@0: 	 * @param CMMRCServerSession& aServerSession
sl@0: 	 * @return KerrNone in case of success of the process
sl@0: 	 */	
sl@0: 	TInt RemoveRequestForAPR(CMMRCServerSession& aServerSession );	
sl@0: 	
sl@0: 	/**
sl@0: 	 * 
sl@0: 	 * @return KerrNone in case of success of the process
sl@0: 	 */	
sl@0: 	TInt WillResumePlay();
sl@0: 	
sl@0: 
sl@0: private:
sl@0: 	/**
sl@0: 	 * Process the first request with the highest priority from the FIFO queue
sl@0: 	 * @return KerrNone in case of success of the process
sl@0: 	 */
sl@0: 	TInt ProcessNextRequestL();
sl@0: 	
sl@0: 	/**
sl@0: 	 * Send a resource request to the adaptation
sl@0: 	 * @param CMMRCServerSession& aServerSession 
sl@0: 	 * @return KerrNone in case of success of the process
sl@0: 	 */
sl@0: 	TInt SendResourceRequest( CMMRCServerSession& aServerSession );
sl@0: 	
sl@0: 	/** 
sl@0: 	 * Send a preemption request to the adaptation
sl@0: 	 * @param CMMRCServerSession& aServerSession 
sl@0: 	 * @return KerrNone in case of success of the process
sl@0: 	 */
sl@0: 	TInt SendPreemptionRequest( CMMRCServerSession& aServerSession );
sl@0: 	
sl@0: 	/**
sl@0: 	 * Pop the decision rule on the base of the current in-process request and a new committed request
sl@0: 	 * @param TAudioState aAudioStateAllocatedResource
sl@0: 	 * @param TAudioState aAudioStateRequiringProcess
sl@0: 	 * @return TMMRCRule
sl@0: 	 */
sl@0: 	TMMRCRule DecisionRule(TAudioState aAudioStateAllocatedResource, TAudioState aAudioStateRequiringProcess);
sl@0: 	
sl@0: 	/**
sl@0: 	 * Pop the action reason on the base of the last committed request and the current one
sl@0: 	 * @param TAudioState aAudioStateLastCommitted
sl@0: 	 * @param TAudioState aAudioStateRequested
sl@0: 	 * @return TReason
sl@0: 	 */
sl@0: 	TReason ActionReason(TAudioState aAudioStateLastCommitted, TAudioState aAudioStateRequested);
sl@0: 	
sl@0: 	/**
sl@0: 	 * Notify all the paused client that a resource has been unallocated
sl@0: 	 */
sl@0: 	void NotifyPausedClientsResourceUnallocated();
sl@0: 
sl@0: 	
sl@0: 	/*
sl@0: 	 * 
sl@0: 	 */
sl@0: 	void Panic(TMMRCServerControllerPanicCodes aCode);
sl@0: 
sl@0: private:
sl@0: 		
sl@0: 	/**
sl@0: 	 * By default Symbian 2nd phase constructor is private.
sl@0: 	 */
sl@0: 	CMMRCServerController();
sl@0: 	
sl@0: 	/**
sl@0: 	 * By default Symbian 2nd phase constructor is private.
sl@0: 	 */
sl@0: 	void ConstructL();
sl@0: 
sl@0: private:
sl@0: 	//owned
sl@0: 	CMMRCServerInfo* iMMRCServerInfo;
sl@0: 	CMMRCServerRuleManager* iMMRCServerRuleManager;
sl@0: 	CARNNotificationObject* iARNNotificationObject;
sl@0: 	};
sl@0: 
sl@0: #endif //__MMRCSERVERCONTROLLER_H__