sl@0: // Copyright (c) 2002-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: // TestFrameworkServer provides a console and/or log
sl@0: // which will handle all output from test threads.
sl@0: // 
sl@0: //
sl@0: 
sl@0: #ifndef __TESTFRAMEWORKSERVER_H__
sl@0: #define __TESTFRAMEWORKSERVER_H__
sl@0: 
sl@0: #include <testframework.h>
sl@0: #include "LogFile.h"
sl@0: #include "ServerConsole.h"
sl@0: 
sl@0: #include <mmf/common/mmfipc.h> // for MmfIpc classes
sl@0: #ifdef SYMBIAN_ENABLE_SPLIT_HEADERS
sl@0: #include <mmf/common/mmfipcserver.h>
sl@0: #endif
sl@0: 
sl@0: class CTestFrameworkServerSession;
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * A timer used to shut the server down after all clients 
sl@0:  * have exited.
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: class CTestFrameworkServerShutdown : public CTimer
sl@0: 	{
sl@0: 	enum
sl@0: 		{
sl@0: 		KTestFrameworkServerShutdownDelay = 5000000 // 5 seconds
sl@0: 		};	
sl@0: public:
sl@0: 	CTestFrameworkServerShutdown();
sl@0: 	void ConstructL();
sl@0: 	void Start();
sl@0: private:
sl@0: 	void RunL();
sl@0: 	};
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Window helper class, allows client and server to set/
sl@0:  * modify (console) windows
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: class TWindow
sl@0: 	{
sl@0: public:
sl@0: 	TWindow();
sl@0: 	TWindow(CTestFrameworkServerSession* aOwner);
sl@0: 	void SetOwner(CTestFrameworkServerSession* aOwner);
sl@0: 	void SetWinRectAndNotifyOwner(const TRect& aWinRect);
sl@0: 	CTestFrameworkServerSession* Owner() {return iOwner;};
sl@0: 	TBool HasOwner();
sl@0: private:
sl@0: 	CTestFrameworkServerSession* iOwner;
sl@0: 	};
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Test Framework Server.
sl@0:  * Responsible for opening/closing console and writing to it.
sl@0:  * Ditto log file.
sl@0:  *
sl@0:  * To be adapted to write to a COM port.
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: class CTestFrameworkServer : public CMmfIpcServer
sl@0: 	{
sl@0: public:
sl@0: 	//construct / destruct
sl@0: 	static CMmfIpcServer* NewL();
sl@0: 	~CTestFrameworkServer();
sl@0: 
sl@0: 	void AddSession();
sl@0: 	void DropSession();
sl@0: 
sl@0: 	void OpenLogL(const TDesC& aLogName, TInt aLogMode);
sl@0: 	void WriteLog(const TDesC& aMsg, TInt aLogMode);
sl@0: 	void CloseLog();
sl@0: 	TInt LogStatus() const;
sl@0: 
sl@0: 	void AddInputWindowL(CTestFrameworkServerSession* aOwner);
sl@0: 	void RemoveWindow(CTestFrameworkServerSession* aOwner);
sl@0: 
sl@0: private:
sl@0: 	CTestFrameworkServer();
sl@0: 	void ConstructL();
sl@0: 	//open/close a session
sl@0: 	CMmfIpcSession* NewSessionL(const TVersion &aVersion) const;
sl@0: 
sl@0: private:
sl@0: 	TInt iSessionCount;	// The number of sessions
sl@0: 	CTestFrameworkServerShutdown iShutdown;// A timer used to shut the server down after all clients have exited.
sl@0: 
sl@0: 	// An active console, receiving output from client messages and input from server
sl@0: 	CServerConsole* iConsole;
sl@0: 
sl@0: 	// logging parms
sl@0: 	TUint iLogMode;
sl@0: 	TBuf<KMaxLogFilenameLength> iLogName;
sl@0: 	CFileLogger* iFileLogger;
sl@0: 
sl@0: 	// last keypress
sl@0: 	TInt iInputKey;
sl@0: 
sl@0: 	TWindow iInputWindow;
sl@0: 	};
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Test Framework Server Session :
sl@0:  * handles message passing between Test Framework client / server
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: class CTestFrameworkServerSession : public CMmfIpcSession
sl@0: 	{
sl@0: public:
sl@0: 	CTestFrameworkServerSession();
sl@0: 	void CreateL(const CMmfIpcServer& aServer);
sl@0: 	void ConstructL();
sl@0: 	~CTestFrameworkServerSession();
sl@0: 
sl@0: 	void ServiceL(const RMmfIpcMessage &aMessage);
sl@0: 	TInt RunError(const RMmfIpcMessage& aMessage, TInt aError);
sl@0: 
sl@0: 	void NotifyWindowChanged(const TRect& aWinRect);
sl@0: 
sl@0: private:
sl@0: 	// async window message handling
sl@0: 	void SetOwnCopyOfWindowMessageL(const RMmfIpcMessage& aMessage);
sl@0: 	void CompleteOwnCopyOfWindowMessage(TInt aReason);
sl@0: 
sl@0: private:
sl@0: 	CTestFrameworkServer* iServer;	//<pointer to owning server
sl@0: 
sl@0: 	// async window message data
sl@0: 	RMmfIpcMessage iWindowMessage;
sl@0: 	TBool iCanCompleteWindowMessage;
sl@0: 	TBool iNeedToNotifyClientOfWindowSizeChange;
sl@0: 	TRectBuf iWinRectBuf;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: 
sl@0: #endif //__TESTFRAMEWORKSERVER_H__