epoc32/include/mw/msventryscheduledata.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 // Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     4 // under the terms of "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 //
    15 
    16 #ifndef MSV_ENTRY_SCHEDULE_DATA_H_
    17 #define MSV_ENTRY_SCHEDULE_DATA_H_
    18 
    19 //
    20 //
    21 //	Includes
    22 //
    23 //
    24 
    25 #include <msvstore.h>
    26 #include <schinfo.h>
    27 #include <csch_cli.h>
    28 #include <schtask.h>
    29 
    30 //
    31 //
    32 //	Constants
    33 //
    34 //
    35 
    36 const TUid KUidMsvFileScheduleData			= {0x100056A2};	//Used by TMsvEntryScheduleData
    37 const TInt16 KMsvEntryScheduleDataVersion	= 1;
    38 
    39 //
    40 //
    41 //	TMsvEntryScheduleData Declaration
    42 //
    43 //
    44 
    45 /**
    46 Stores message-specific data related to scheduling.
    47 
    48 The data is not required by the Client/UI side. This data is stored in a 
    49 stream associated with the TMsvEntry. 
    50 
    51 @publishedAll
    52 @released
    53 */
    54 
    55 class TMsvEntryScheduleData
    56 	{
    57 public:
    58 	IMPORT_C TMsvEntryScheduleData();
    59 
    60 	IMPORT_C void RestoreL(CMsvStore& aStore);
    61 	IMPORT_C void StoreL(CMsvStore& aStore) const;
    62 	IMPORT_C void RemoveL(CMsvStore& aStore) const;
    63 
    64 	IMPORT_C void Reset();
    65 	IMPORT_C TBool IsReset() const;
    66 
    67 	IMPORT_C TInt Retries() const;
    68 	IMPORT_C void IncreaseRetries();
    69 	IMPORT_C void ResetRetries();
    70 
    71 	/**
    72 	The Task ID returned by the Task Scheduler when the message is 
    73 	scheduled.
    74 	*/
    75 	TInt				iTaskId;
    76 	
    77 	/**
    78 	The TSchedulerItemRef returned by the Task Scheduler when the schedule 
    79 	on which the message is scheduled is created.
    80 	*/
    81 	TSchedulerItemRef	iRef;
    82 
    83 protected:
    84 	/** The number of retries that have been made to send this message. */
    85 	TInt				iRetryCount;
    86 	/** Structure version. */
    87 	TInt16				iVersion;
    88 
    89 	void ExternalizeL(RWriteStream& aWriteStream) const;
    90 	void InternalizeL(RReadStream& aReadStream);
    91 	};
    92 
    93 #endif