epoc32/include/mw/msventryscheduledata.h
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 2fe1408b6811
child 4 837f303aceeb
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/mw/msventryscheduledata.h	Wed Mar 31 12:27:01 2010 +0100
     1.3 @@ -0,0 +1,101 @@
     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 +/// All rights reserved.
    1.18 +/// This component and the accompanying materials are made available
    1.19 +/// 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.20 +/// which accompanies this distribution, and is available
    1.21 +/// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.22 +/// Initial Contributors:
    1.23 +/// Nokia Corporation - initial contribution.
    1.24 +/// Contributors:
    1.25 +///
    1.26 +
    1.27 +#ifndef MSV_ENTRY_SCHEDULE_DATA_H_
    1.28 +#define MSV_ENTRY_SCHEDULE_DATA_H_
    1.29 +
    1.30 +/////////////////////////////////////////////////////////////////////////////
    1.31 +//
    1.32 +//	Includes
    1.33 +//
    1.34 +/////////////////////////////////////////////////////////////////////////////
    1.35 +
    1.36 +#include <msvstore.h>
    1.37 +#include <schinfo.h>
    1.38 +#include <csch_cli.h>
    1.39 +#include <schtask.h>
    1.40 +
    1.41 +/////////////////////////////////////////////////////////////////////////////
    1.42 +//
    1.43 +//	Constants
    1.44 +//
    1.45 +/////////////////////////////////////////////////////////////////////////////
    1.46 +
    1.47 +const TUid KUidMsvFileScheduleData			= {0x100056A2};	//Used by TMsvEntryScheduleData
    1.48 +const TInt16 KMsvEntryScheduleDataVersion	= 1;
    1.49 +
    1.50 +/////////////////////////////////////////////////////////////////////////////
    1.51 +//
    1.52 +//	TMsvEntryScheduleData Declaration
    1.53 +//
    1.54 +/////////////////////////////////////////////////////////////////////////////
    1.55 +
    1.56 +/**
    1.57 +Stores message-specific data related to scheduling.
    1.58 +
    1.59 +The data is not required by the Client/UI side. This data is stored in a 
    1.60 +stream associated with the TMsvEntry. 
    1.61 +
    1.62 +@publishedAll
    1.63 +@released
    1.64 +*/
    1.65 +
    1.66 +class TMsvEntryScheduleData
    1.67 +	{
    1.68 +public:
    1.69 +	IMPORT_C TMsvEntryScheduleData();
    1.70 +
    1.71 +	IMPORT_C void RestoreL(CMsvStore& aStore);
    1.72 +	IMPORT_C void StoreL(CMsvStore& aStore) const;
    1.73 +	IMPORT_C void RemoveL(CMsvStore& aStore) const;
    1.74 +
    1.75 +	IMPORT_C void Reset();
    1.76 +	IMPORT_C TBool IsReset() const;
    1.77 +
    1.78 +	IMPORT_C TInt Retries() const;
    1.79 +	IMPORT_C void IncreaseRetries();
    1.80 +	IMPORT_C void ResetRetries();
    1.81 +
    1.82 +	/**
    1.83 +	The Task ID returned by the Task Scheduler when the message is 
    1.84 +	scheduled.
    1.85 +	*/
    1.86 +	TInt				iTaskId;
    1.87 +	
    1.88 +	/**
    1.89 +	The TSchedulerItemRef returned by the Task Scheduler when the schedule 
    1.90 +	on which the message is scheduled is created.
    1.91 +	*/
    1.92 +	TSchedulerItemRef	iRef;
    1.93 +
    1.94 +protected:
    1.95 +	/** The number of retries that have been made to send this message. */
    1.96 +	TInt				iRetryCount;
    1.97 +	/** Structure version. */
    1.98 +	TInt16				iVersion;
    1.99 +
   1.100 +	void ExternalizeL(RWriteStream& aWriteStream) const;
   1.101 +	void InternalizeL(RReadStream& aReadStream);
   1.102 +	};
   1.103 +
   1.104 +#endif