os/mm/mmlibs/mmfw/src/server/BaseClasses/mmfsubthreadbase.cpp
author sl@SLION-WIN7.fritz.box
Fri, 15 Jun 2012 03:10:57 +0200
changeset 0 bde4ae8d615e
permissions -rw-r--r--
First public contribution.
sl@0
     1
// Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0
     2
// All rights reserved.
sl@0
     3
// This component and the accompanying materials are made available
sl@0
     4
// under the terms of "Eclipse Public License v1.0"
sl@0
     5
// which accompanies this distribution, and is available
sl@0
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0
     7
//
sl@0
     8
// Initial Contributors:
sl@0
     9
// Nokia Corporation - initial contribution.
sl@0
    10
//
sl@0
    11
// Contributors:
sl@0
    12
//
sl@0
    13
// Description:
sl@0
    14
//
sl@0
    15
sl@0
    16
#include <mmf/server/mmfsubthreadbase.h>
sl@0
    17
#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS
sl@0
    18
#include <mmf/server/mmfsubthreadbaseimpl.h>
sl@0
    19
#endif
sl@0
    20
sl@0
    21
sl@0
    22
EXPORT_C void RMMFSubThreadBase::ReceiveEvents(TMMFEventPckg& aEventPckg, TRequestStatus& aStatus)
sl@0
    23
	{
sl@0
    24
	SendReceiveResult(EMMFSubThreadReceiveEvents, aEventPckg, aStatus);
sl@0
    25
	}
sl@0
    26
sl@0
    27
EXPORT_C TInt RMMFSubThreadBase::CancelReceiveEvents()
sl@0
    28
	{
sl@0
    29
	return SendReceive(EMMFSubThreadCancelReceiveEvents);
sl@0
    30
	}
sl@0
    31
sl@0
    32
EXPORT_C void RMMFSubThreadBase::Shutdown()
sl@0
    33
	{
sl@0
    34
	if (iSubThread.Handle() != KNullHandle)
sl@0
    35
		{
sl@0
    36
		// check that the subthread has yet to terminate
sl@0
    37
		if (iLogonStatus == KRequestPending)
sl@0
    38
			{	
sl@0
    39
			//close the subthread and wait for its exit.
sl@0
    40
			//signal to the subthread to close down.			
sl@0
    41
			TInt shutdownError = SendReceive(EMMFSubThreadShutdown);
sl@0
    42
			if (shutdownError != KErrNone)
sl@0
    43
				{
sl@0
    44
				iSubThread.LogonCancel(iLogonStatus);
sl@0
    45
				}
sl@0
    46
			else
sl@0
    47
				{
sl@0
    48
				RTimer timer;
sl@0
    49
				TInt err = timer.CreateLocal();
sl@0
    50
				//if we managed to create the timer, wait for both the death and the timeout to minimise the risk of deadlock
sl@0
    51
				if (!err)
sl@0
    52
					{
sl@0
    53
					TRequestStatus timeout;
sl@0
    54
					timer.After(timeout, iShutdownTimeout);
sl@0
    55
					User::WaitForRequest(iLogonStatus, timeout);
sl@0
    56
					if (iLogonStatus == KRequestPending)
sl@0
    57
						{
sl@0
    58
						//we have timed out.  Panic the thread in debug mode, kill it in release mode.
sl@0
    59
						iSubThread.LogonCancel(iLogonStatus);
sl@0
    60
						User::WaitForRequest(iLogonStatus);
sl@0
    61
					#ifdef _DEBUG	
sl@0
    62
						Panic(EMMFSubThreadPanicTimedOut);
sl@0
    63
					#else
sl@0
    64
						iSubThread.Kill(KErrDied);
sl@0
    65
					#endif
sl@0
    66
						}
sl@0
    67
					else
sl@0
    68
						{
sl@0
    69
						//subthread has exited. Cancel the timer.
sl@0
    70
						timer.Cancel();
sl@0
    71
						User::WaitForRequest(timeout);
sl@0
    72
						}
sl@0
    73
					}
sl@0
    74
				else
sl@0
    75
					{
sl@0
    76
					//we have no timer so we'll just have to risk the deadlock
sl@0
    77
					User::WaitForRequest(iLogonStatus);
sl@0
    78
					}
sl@0
    79
				timer.Close();
sl@0
    80
				}
sl@0
    81
			}
sl@0
    82
		//close the handle to the subthread
sl@0
    83
		iSubThread.Close();
sl@0
    84
		}
sl@0
    85
	// close our parent
sl@0
    86
	RHandleBase::Close(); 
sl@0
    87
	}
sl@0
    88
	
sl@0
    89
void RMMFSubThreadBase::Panic(TMMFSubThreadPanicCode aPanicCode)
sl@0
    90
	{
sl@0
    91
	_LIT(KMMFSubThreadPanicCategory, "MMFSubThread");
sl@0
    92
	iSubThread.Panic(KMMFSubThreadPanicCategory, aPanicCode);
sl@0
    93
	}
sl@0
    94
sl@0
    95
TInt RMMFSubThreadBase::DoCreateSubThread(const TDesC& aName, TThreadFunction aFunction, TBool aUseNewHeap)
sl@0
    96
	{
sl@0
    97
	TInt error = KErrNone;
sl@0
    98
sl@0
    99
	if (aUseNewHeap)
sl@0
   100
		{
sl@0
   101
		error = iSubThread.Create(aName, aFunction,
sl@0
   102
			KDefaultStackSize, KMinHeapSize, KMMFSubThreadMaxHeapSize, 
sl@0
   103
			NULL, EOwnerThread);
sl@0
   104
		}
sl@0
   105
	else
sl@0
   106
		{
sl@0
   107
		error = iSubThread.Create(aName, aFunction,
sl@0
   108
			KDefaultStackSize, &User::Heap(), 
sl@0
   109
			NULL, EOwnerThread);
sl@0
   110
		}
sl@0
   111
sl@0
   112
	if (error)
sl@0
   113
		{
sl@0
   114
		return error;
sl@0
   115
		}
sl@0
   116
	
sl@0
   117
	TRequestStatus rendezvous;
sl@0
   118
	iSubThread.Rendezvous(rendezvous);
sl@0
   119
	
sl@0
   120
	if (rendezvous != KRequestPending)
sl@0
   121
		{
sl@0
   122
		iSubThread.Kill(0);
sl@0
   123
		}
sl@0
   124
	else
sl@0
   125
		{
sl@0
   126
		iLogonStatus = KRequestPending;
sl@0
   127
		iSubThread.Logon(iLogonStatus);
sl@0
   128
		if (iLogonStatus != KRequestPending)
sl@0
   129
			{
sl@0
   130
			// Failed to log on
sl@0
   131
			iSubThread.RendezvousCancel(rendezvous);
sl@0
   132
			User::WaitForRequest(rendezvous);
sl@0
   133
			iSubThread.Kill(0);
sl@0
   134
			iSubThread.Close();
sl@0
   135
			return iLogonStatus.Int();
sl@0
   136
			}
sl@0
   137
		else
sl@0
   138
			{
sl@0
   139
			iSubThread.Resume();		
sl@0
   140
			}
sl@0
   141
		}
sl@0
   142
	User::WaitForRequest(rendezvous); // wait for start or death
sl@0
   143
	
sl@0
   144
	if (rendezvous != KErrNone)
sl@0
   145
		{
sl@0
   146
		iSubThread.LogonCancel(iLogonStatus);
sl@0
   147
		User::WaitForRequest(iLogonStatus);
sl@0
   148
		iSubThread.Close();
sl@0
   149
		return rendezvous.Int();
sl@0
   150
		}
sl@0
   151
		
sl@0
   152
	return KErrNone;	
sl@0
   153
	}
sl@0
   154
sl@0
   155
CMMFSubThreadShutdown* CMMFSubThreadShutdown::NewL() 
sl@0
   156
	{
sl@0
   157
	CMMFSubThreadShutdown* s = new(ELeave) CMMFSubThreadShutdown();
sl@0
   158
	CleanupStack::PushL(s);
sl@0
   159
	s->ConstructL();
sl@0
   160
	CleanupStack::Pop();
sl@0
   161
	return s;
sl@0
   162
	}
sl@0
   163
sl@0
   164
CMMFSubThreadShutdown::CMMFSubThreadShutdown() : 
sl@0
   165
	CTimer(EPriorityLow)
sl@0
   166
	{
sl@0
   167
	CActiveScheduler::Add(this);
sl@0
   168
	}
sl@0
   169
sl@0
   170
void CMMFSubThreadShutdown::ConstructL()
sl@0
   171
	{
sl@0
   172
	CTimer::ConstructL();
sl@0
   173
	}
sl@0
   174
sl@0
   175
void CMMFSubThreadShutdown::Start()
sl@0
   176
	{
sl@0
   177
	After(EMMFSubThreadShutdownDelay);
sl@0
   178
	}
sl@0
   179
sl@0
   180
void CMMFSubThreadShutdown::RunL()
sl@0
   181
	{
sl@0
   182
	ShutdownNow();
sl@0
   183
	}
sl@0
   184
sl@0
   185
void CMMFSubThreadShutdown::ShutdownNow()
sl@0
   186
	{
sl@0
   187
	CActiveScheduler::Stop();
sl@0
   188
	}
sl@0
   189
sl@0
   190
sl@0
   191
sl@0
   192
sl@0
   193
CMMFSubThreadServer::CMMFSubThreadServer(TInt aPriority) :
sl@0
   194
	CMmfIpcServer(aPriority)
sl@0
   195
	{
sl@0
   196
	}
sl@0
   197
sl@0
   198
void CMMFSubThreadServer::ConstructL()
sl@0
   199
	{
sl@0
   200
	StartL(RThread().Name());
sl@0
   201
	iShutdownTimer = CMMFSubThreadShutdown::NewL();
sl@0
   202
	iShutdownTimer->Start();
sl@0
   203
	}
sl@0
   204
sl@0
   205
CMMFSubThreadServer::~CMMFSubThreadServer()
sl@0
   206
	{
sl@0
   207
	delete iShutdownTimer;
sl@0
   208
	}
sl@0
   209
sl@0
   210
void CMMFSubThreadServer::SessionCreated()
sl@0
   211
	{
sl@0
   212
	//stop the shutdown timer
sl@0
   213
	iShutdownTimer->Cancel();
sl@0
   214
	}
sl@0
   215
sl@0
   216
void CMMFSubThreadServer::ShutdownNow()
sl@0
   217
	{
sl@0
   218
	iShutdownTimer->ShutdownNow();
sl@0
   219
	}
sl@0
   220
sl@0
   221
TInt CMMFSubThreadServer::RunError(TInt aError)
sl@0
   222
	{
sl@0
   223
	//signal the client
sl@0
   224
	Message().Complete(aError);
sl@0
   225
	ReStart();
sl@0
   226
	return KErrNone;
sl@0
   227
	}
sl@0
   228
sl@0
   229
sl@0
   230
sl@0
   231
sl@0
   232
sl@0
   233
CMMFSubThreadEventReceiver* CMMFSubThreadEventReceiver::NewL(const RMmfIpcMessage& aMessage)
sl@0
   234
	{
sl@0
   235
	return new(ELeave) CMMFSubThreadEventReceiver(aMessage);
sl@0
   236
	}
sl@0
   237
sl@0
   238
CMMFSubThreadEventReceiver::~CMMFSubThreadEventReceiver()
sl@0
   239
	{
sl@0
   240
	if (iNeedToCompleteMessage)
sl@0
   241
		iMessage.Complete(KErrDied);
sl@0
   242
	}
sl@0
   243
sl@0
   244
void CMMFSubThreadEventReceiver::SendEvent(const TMMFEvent& aEvent)
sl@0
   245
	{
sl@0
   246
	TMMFEventPckg eventpckg(aEvent);
sl@0
   247
	TRAPD(err, MmfMessageUtil::WriteL(iMessage, 0, eventpckg));
sl@0
   248
	iMessage.Complete(err);
sl@0
   249
	iNeedToCompleteMessage = EFalse;
sl@0
   250
	}
sl@0
   251
sl@0
   252
CMMFSubThreadEventReceiver::CMMFSubThreadEventReceiver(const RMmfIpcMessage& aMessage) : 
sl@0
   253
	iMessage(aMessage)
sl@0
   254
	{
sl@0
   255
	iNeedToCompleteMessage = ETrue;
sl@0
   256
	}
sl@0
   257
sl@0
   258
sl@0
   259
sl@0
   260
sl@0
   261
sl@0
   262
sl@0
   263
void CMMFSubThreadSession::CreateL(const CMmfIpcServer& aServer)
sl@0
   264
	{
sl@0
   265
	CMmfIpcSession::CreateL(aServer);
sl@0
   266
	iServer = STATIC_CAST(CMMFSubThreadServer*, (CONST_CAST(CMmfIpcServer*, &aServer)));
sl@0
   267
	iServer->SessionCreated();
sl@0
   268
	}
sl@0
   269
sl@0
   270
sl@0
   271
CMMFSubThreadSession::~CMMFSubThreadSession()
sl@0
   272
	{
sl@0
   273
	delete iEventReceiver;
sl@0
   274
	iEvents.Close();
sl@0
   275
	}
sl@0
   276
sl@0
   277
sl@0
   278
TBool CMMFSubThreadSession::ReceiveEventsL(const RMmfIpcMessage& aMessage)
sl@0
   279
	{
sl@0
   280
	if (iEventReceiver)
sl@0
   281
		User::Leave(KErrAlreadyExists);
sl@0
   282
	iEventReceiver = CMMFSubThreadEventReceiver::NewL(aMessage);
sl@0
   283
	//send the next cached event (if any) to the client
sl@0
   284
	if (iEvents.Count() > 0)
sl@0
   285
		{
sl@0
   286
		TMMFEvent& event = iEvents[0];
sl@0
   287
		iEventReceiver->SendEvent(event);
sl@0
   288
		delete iEventReceiver;
sl@0
   289
		iEventReceiver=NULL;
sl@0
   290
		iEvents.Remove(0);
sl@0
   291
		}
sl@0
   292
	return EFalse;
sl@0
   293
	}
sl@0
   294
sl@0
   295
TBool CMMFSubThreadSession::CancelReceiveEvents()
sl@0
   296
	{
sl@0
   297
	delete iEventReceiver;
sl@0
   298
	iEventReceiver = NULL;
sl@0
   299
	return ETrue;
sl@0
   300
	}
sl@0
   301
sl@0
   302
TBool CMMFSubThreadSession::ShutDown()
sl@0
   303
	{
sl@0
   304
	iServer->ShutdownNow();
sl@0
   305
	return ETrue;
sl@0
   306
	}
sl@0
   307
sl@0
   308
TInt CMMFSubThreadSession::SendEventToClient(const TMMFEvent& aEvent)
sl@0
   309
	{
sl@0
   310
	TInt error = KErrNone;
sl@0
   311
	if (iEventReceiver)
sl@0
   312
		{
sl@0
   313
		//send event to client now
sl@0
   314
		iEventReceiver->SendEvent(aEvent);
sl@0
   315
		delete iEventReceiver;
sl@0
   316
		iEventReceiver=NULL;
sl@0
   317
		error = KErrNone;
sl@0
   318
		}
sl@0
   319
	else
sl@0
   320
		{
sl@0
   321
		//queue the request for later
sl@0
   322
		TMMFEvent event(aEvent);
sl@0
   323
		//if we've exceeded the max number of cached messages, delete the first and append this one to the end
sl@0
   324
		if (iEvents.Count() >= KMMFSubThreadMaxCachedMessages)
sl@0
   325
			iEvents.Remove(0);
sl@0
   326
		error = iEvents.Append(event);
sl@0
   327
		}
sl@0
   328
	return error;
sl@0
   329
	}
sl@0
   330
sl@0
   331