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