sl@0: // Copyright (c) 2010 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: // Client / server logging for Test Framework
sl@0: // NOTE : does NOT include secure API changes in EKA2
sl@0: // 
sl@0: //
sl@0: 
sl@0: 
sl@0: // Test system includes
sl@0: #include <testframework.h>
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Global : start a server
sl@0:  * NOTE. Function is global static as only one server will ever run at any time
sl@0:  * (there may be multiple client sessions)
sl@0:  *
sl@0:  * @return	"TInt"
sl@0:  *			Error code (KErrNone if successful)
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: GLDEF_C TInt StartServer()
sl@0: // Start the server process/thread which lives in an (EPOC)EXE object
sl@0: 	{
sl@0: 	const TUidType serverUid(KNullUid, KNullUid, KTestFrameworkServerUid3);
sl@0: 
sl@0: 
sl@0: // EPOC is easy, we just create a new server process. Simultaneous launching
sl@0: // of two such processes should be detected when the second one attempts to
sl@0: // create the server object, failing with KErrAlreadyExists.
sl@0: 
sl@0: 	RProcess server;
sl@0: 	TInt r = server.Create(KTestFrameworkServerImg, KNullDesC, serverUid);
sl@0: 
sl@0: 	if (r != KErrNone)
sl@0: 		return r;
sl@0: 
sl@0: 	
sl@0: 	TRequestStatus rendezvous;
sl@0: 	server.Rendezvous(rendezvous);
sl@0: 
sl@0: 	if (rendezvous!=KRequestPending)
sl@0: 		{
sl@0: 		server.Kill(0);
sl@0: 		}
sl@0: 	else
sl@0: 		{
sl@0: 		server.Resume();
sl@0: 		}
sl@0: 
sl@0: 
sl@0: 	User::WaitForRequest(rendezvous);		// wait for start or death
sl@0: 
sl@0: 	// we can't use the 'exit reason' if the server panicked as this
sl@0: 	// is the panic 'reason' and may be '0' which cannot be distinguished
sl@0: 	// from KErrNone
sl@0: 	if (rendezvous!=KErrNone)
sl@0: 		{
sl@0: 		server.Close();
sl@0: 		}
sl@0: 
sl@0: 	// server started (at last). Cancel and consume the death-notification
sl@0: 	// before reporting success
sl@0: 	return rendezvous.Int();
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Constructor for RTestFrameworkClientSession
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: RTestFrameworkClientSession::RTestFrameworkClientSession()
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Client session : connect to server.
sl@0:  * Will start a new server session if no server exists
sl@0:  *
sl@0:  * @return	"TInt"
sl@0:  *			Error code (KErrNone if connect successful)
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: TInt RTestFrameworkClientSession::Connect()
sl@0: 	{
sl@0: 	// NOTE : this loop is ugly and can probably be rewritten to be more graceful
sl@0: 	const TInt KNumRetries = 2;
sl@0: 
sl@0: 	TInt retry = KNumRetries;
sl@0: 	for (;;)
sl@0: 		{
sl@0: 		TInt r = CreateSession(KTestFrameworkServerName, TVersion(KTestFrameworkServerMajorVersionNumber,
sl@0: 																  KTestFrameworkServerMinorVersionNumber,
sl@0: 																  KTestFrameworkServerBuildVersionNumber));
sl@0: 		if (r == KErrNone)
sl@0: 			{
sl@0: #ifdef __IPC_V2_PRESENT__
sl@0: 			r = ShareAuto();
sl@0: #else
sl@0: 			r = Share(RSessionBase::EAutoAttach);
sl@0: #endif
sl@0: 			if (r!=KErrNone)
sl@0: 				Close();
sl@0: 			return r;
sl@0: 			}
sl@0: 		if (r != KErrNotFound && r != KErrServerTerminated)
sl@0: 			{
sl@0: 			return r;
sl@0: 			}
sl@0: 		if (--retry == 0)
sl@0: 			return r;
sl@0: 		r = StartServer();
sl@0: 		if (r != KErrNone && r != KErrAlreadyExists)
sl@0: 			return r;
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Request creation of an input window.
sl@0:  * NOTE. For initialisation of input console only - unlikely to
sl@0:  * be required by user
sl@0:  *
sl@0:  * @param	"TRectBuf& aAllocatedWindow"
sl@0:  *			Window dimensions
sl@0:  *
sl@0:  * @param	"TRequestStatus& aReqStat"
sl@0:  *			Request status
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: void RTestFrameworkClientSession::CreateInputWindow(TRectBuf& aAllocatedWindow, TRequestStatus& aReqStat)
sl@0: 	{
sl@0: 	SendReceiveResult(ECreateInputWindow, aAllocatedWindow, aReqStat);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Request window change notifications
sl@0:  * NOTE. For initialisation of input console only - unlikely to
sl@0:  * be required by user
sl@0:  *
sl@0:  * @param	"TRectBuf& aNewWindow"
sl@0:  *			New window dimensions
sl@0:  *
sl@0:  * @param	"TRequestStatus& aReqStat"
sl@0:  *			Request status
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: void RTestFrameworkClientSession::NotifyIfWindowChange(TRectBuf& aNewWindow, TRequestStatus& aReqStat)
sl@0: 	{
sl@0: 	SendReceiveResult(ENotifyIfWindowChange, aNewWindow, aReqStat);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Cancel window change notifications
sl@0:  * NOTE. For initialisation of input console only - unlikely to
sl@0:  * be required by user
sl@0:  *
sl@0:  * @return	"TInt"
sl@0:  *			SendReceive error code
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: TInt RTestFrameworkClientSession::CancelNotifyIfWindowChange()
sl@0: 	{
sl@0: 	return SendReceive(ECancelNotifyIfWindowChange);
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Open a log server session
sl@0:  *
sl@0:  * @param	"const TDesC& aLogName"
sl@0:  *			The log name
sl@0:  *
sl@0:  * @param	"TInt aLogMode"
sl@0:  *			The log mode (a bitmask of TTestFrameworkLogMode)
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: void RTestFrameworkClientSession::OpenLog(const TDesC& aLogName, TInt aLogMode)
sl@0: 	{
sl@0: 	(void) SendReceive(EOpenLog, aLogName, aLogMode);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Write message string to log server session
sl@0:  *
sl@0:  * @param	"const TDesC& aMsg"
sl@0:  *			The message string
sl@0:  *
sl@0:  * @param	"TInt aLogMode"
sl@0:  *			The log mode (a bitmask of TTestFrameworkLogMode)
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: void RTestFrameworkClientSession::WriteLog(const TDesC& aMsg, TInt aLogMode)
sl@0: 	{
sl@0: 	(void) SendReceive(EWriteLog, aMsg, aLogMode);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Send close log message to server
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: void RTestFrameworkClientSession::CloseLog()
sl@0: 	{
sl@0: 	SendReceive(ECloseLog);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Retrieve log status from server
sl@0:  *
sl@0:  * @return	"TInt"
sl@0:  *			The log status (a bitmask of TTestFrameworkLogMode)
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: TInt RTestFrameworkClientSession::LogStatus()
sl@0: 	{
sl@0: 	TInt res = 0;
sl@0: 	TPckgBuf<TInt> pckg;
sl@0: 	TInt r = SendReceiveResult(ELogStatus, pckg);
sl@0: 	if (r != KErrNone)
sl@0: 	{
sl@0: 		// RTestFrameworkClientSession does not log - 
sl@0: 		// we can however return 0 to indicate an error (no outputs)
sl@0: 		res = 0;
sl@0: 	}
sl@0: 	else
sl@0: 		res = pckg();
sl@0: 	return res;
sl@0: 	}