epoc32/include/schedulebaseservermtm.h
branchSymbian2
changeset 2 2fe1408b6811
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/schedulebaseservermtm.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -0,0 +1,117 @@
     1.4 +// Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.5 +// All rights reserved.
     1.6 +// This component and the accompanying materials are made available
     1.7 +// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     1.8 +// which accompanies this distribution, and is available
     1.9 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.10 +//
    1.11 +// Initial Contributors:
    1.12 +// Nokia Corporation - initial contribution.
    1.13 +//
    1.14 +// Contributors:
    1.15 +//
    1.16 +// Description:
    1.17 +//
    1.18 +
    1.19 +
    1.20 +#ifndef SCHEDULE_BASE_SERVER_MTM_H_
    1.21 +#define SCHEDULE_BASE_SERVER_MTM_H_
    1.22 +
    1.23 +/////////////////////////////////////////////////////////////////////////////
    1.24 +//
    1.25 +//	CScheduleBaseServerMtm Declaration
    1.26 +//
    1.27 +/////////////////////////////////////////////////////////////////////////////
    1.28 +
    1.29 + 
    1.30 +
    1.31 +#include <mtsr.h>
    1.32 +#include <barsc.h>
    1.33 +
    1.34 +
    1.35 +class CMsvScheduleSend;
    1.36 +class CMsvSysAgentActions;
    1.37 +class TMsvSendErrorAction;
    1.38 +class TMsvSchedulePackage;
    1.39 +class CRepository;
    1.40 +
    1.41 +class CScheduleBaseServerMtm : public CBaseServerMtm
    1.42 +/**
    1.43 +Base class for Server MTMs that support scheduling.
    1.44 +
    1.45 +It contains pure virtual functions which must be implemented by the Server 
    1.46 +MTM. These functions are not required for interoperability with any other 
    1.47 +classes, however they are essential functionality that must be implemented 
    1.48 +by a Server MTM that support scheduling.
    1.49 +
    1.50 +CScheduleBaseServerMtm uses a class derived from CMsvScheduleSend to
    1.51 +interface with the task scheduler.
    1.52 +
    1.53 +@see CMsvScheduleSend
    1.54 +@publishedAll
    1.55 +@released
    1.56 +*/
    1.57 +	{
    1.58 +protected:
    1.59 +
    1.60 +//	--- Construction ---
    1.61 +
    1.62 +	IMPORT_C CScheduleBaseServerMtm(CRegisteredMtmDll& aRegisteredMtmDll, CMsvServerEntry* aServerEntry);
    1.63 +
    1.64 +//	--- Send the Scheduled Messages ---
    1.65 +
    1.66 +	IMPORT_C virtual void SendScheduledL(CMsvEntrySelection& aSelection, const TBool aMove, const TDesC8& aParameter, TRequestStatus& aStatus);
    1.67 +	IMPORT_C virtual void ScheduleL(CMsvEntrySelection& aSelection, const TBool aMove, const TDesC8& aParameter, TRequestStatus& aStatus);
    1.68 +	IMPORT_C virtual void ConstructL();
    1.69 +	IMPORT_C void LoadResourceFileL(const TDesC& aResFileName);
    1.70 +
    1.71 +// Other Schedule Commands
    1.72 +
    1.73 +	IMPORT_C virtual void CheckScheduleL(const CMsvEntrySelection& aSelection, const TDesC8& aParameter, TRequestStatus& aStatus);
    1.74 +	IMPORT_C virtual void DeleteScheduleL(const CMsvEntrySelection& aSelection, const TDesC8& aParameter, TRequestStatus& aStatus);
    1.75 +
    1.76 +//	--- Pure virtual functions that must be implemented in a derived class ---
    1.77 +
    1.78 +	/**
    1.79 +	Populates a TMsvSchedulePackage object with scheduling information.
    1.80 +	
    1.81 +	@param aParameter Parameter information for the package
    1.82 +	@param aMove Flag that signals whether a move or copy is required
    1.83 +	@param aPackage On return, a populated object
    1.84 +	*/
    1.85 +	virtual void PopulateSchedulePackage(const TDesC8& aParameter, const TBool aMove, TMsvSchedulePackage& aPackage) const = 0;
    1.86 +	
    1.87 +	/**
    1.88 +	Loads the resource file (if any) for the MTM.
    1.89 +	*/
    1.90 +	virtual void LoadResourceFileL() = 0;
    1.91 +
    1.92 +
    1.93 +	IMPORT_C void Queue(TRequestStatus& aStatus);
    1.94 +
    1.95 +	IMPORT_C void LoadScheduleSettingsL(CRepository& aRepository, TBool aRestoreErrorsFromResource = EFalse, TInt aErrorsResourceId = 0);
    1.96 +
    1.97 +protected:
    1.98 +
    1.99 +	IMPORT_C ~CScheduleBaseServerMtm();
   1.100 +
   1.101 +private:
   1.102 +
   1.103 +	void RequestComplete(TRequestStatus* aStatus, TInt aError);
   1.104 +
   1.105 +protected:
   1.106 +
   1.107 +//	--- Data Member ---
   1.108 +
   1.109 +	/** Message scheduler. */
   1.110 +	CMsvScheduleSend* iScheduleSend; //Should be constructed and deleted by the derived class
   1.111 +
   1.112 +	/** MTM resource file. */
   1.113 +	RResourceFile iResourceFile;
   1.114 +	/** File server handle. */
   1.115 +	RFs iFs;
   1.116 +	/** Asynchronous status word. */
   1.117 +	TRequestStatus* iReport;
   1.118 +	};
   1.119 +
   1.120 +#endif