epoc32/include/msvschedulepackage.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_SCHEDULE_PACKAGE_H_
williamr@2
    25
#define MSV_SCHEDULE_PACKAGE_H_
williamr@2
    26
williamr@2
    27
/////////////////////////////////////////////////////////////////////////////
williamr@2
    28
//
williamr@2
    29
//	TMsvSchedulePackage Declaration
williamr@2
    30
//
williamr@2
    31
/////////////////////////////////////////////////////////////////////////////
williamr@2
    32
williamr@2
    33
const TInt KMaxParameterLength = 256;
williamr@2
    34
williamr@2
    35
class TTaskInfo;
williamr@2
    36
williamr@2
    37
williamr@2
    38
/**
williamr@2
    39
Packaged message scheduling information. 
williamr@2
    40
williamr@2
    41
@publishedAll
williamr@2
    42
@released
williamr@2
    43
*/
williamr@2
    44
williamr@2
    45
class TMsvSchedulePackage
williamr@2
    46
	{
williamr@2
    47
public:
williamr@2
    48
	IMPORT_C TMsvSchedulePackage();
williamr@2
    49
	
williamr@2
    50
	IMPORT_C void PackLC(TTaskInfo& aTask, HBufC*& aDes) const;
williamr@2
    51
	IMPORT_C void UnpackL(const TTaskInfo& aTask, const TDesC& aDes);
williamr@2
    52
williamr@2
    53
private:
williamr@2
    54
williamr@2
    55
	HBufC* PackLC() const;
williamr@2
    56
	void UnpackL(const TDesC& aDes);
williamr@2
    57
williamr@2
    58
	void ExternalizeL(RWriteStream&) const;
williamr@2
    59
	void InternalizeL(RReadStream&);
williamr@2
    60
williamr@2
    61
	TPtrC Convert(const TDesC8& aDes) const;
williamr@2
    62
	TPtrC8 Convert(const TDesC16& aDes) const;
williamr@2
    63
williamr@2
    64
public:
williamr@2
    65
williamr@2
    66
	/** Message ID. */
williamr@2
    67
	TMsvId iId;
williamr@2
    68
williamr@2
    69
	/** Command ID to be passed to CMsvSession::TransferCommandL() when it is
williamr@2
    70
	time to send the messages. */
williamr@2
    71
	TInt iCommandId;
williamr@2
    72
williamr@2
    73
	/** Intervals at which the scheduler should check the sending operation's
williamr@2
    74
	progress. */
williamr@2
    75
	TTimeIntervalMicroSeconds32 iPollProgress;
williamr@2
    76
williamr@2
    77
	/** Server MTM specific binary data to be passed to 
williamr@2
    78
	CMsvSession::TransferCommandL() when it is time to send the messages. */
williamr@2
    79
	TBuf8<KMaxParameterLength> iParameter;
williamr@2
    80
williamr@2
    81
	};
williamr@2
    82
williamr@2
    83
#endif