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