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
     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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     5 /// which accompanies this distribution, and is available
     6 /// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     7 ///
     8 /// Initial Contributors:
     9 /// Nokia Corporation - initial contribution.
    10 ///
    11 /// Contributors:
    12 ///
    13 /// Description:
    14 /// All rights reserved.
    15 /// This component and the accompanying materials are made available
    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
    17 /// which accompanies this distribution, and is available
    18 /// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    19 /// Initial Contributors:
    20 /// Nokia Corporation - initial contribution.
    21 /// Contributors:
    22 ///
    23 
    24 #ifndef MSV_SCHEDULE_PACKAGE_H_
    25 #define MSV_SCHEDULE_PACKAGE_H_
    26 
    27 /////////////////////////////////////////////////////////////////////////////
    28 //
    29 //	TMsvSchedulePackage Declaration
    30 //
    31 /////////////////////////////////////////////////////////////////////////////
    32 
    33 const TInt KMaxParameterLength = 256;
    34 
    35 class TTaskInfo;
    36 
    37 
    38 /**
    39 Packaged message scheduling information. 
    40 
    41 @publishedAll
    42 @released
    43 */
    44 
    45 class TMsvSchedulePackage
    46 	{
    47 public:
    48 	IMPORT_C TMsvSchedulePackage();
    49 	
    50 	IMPORT_C void PackLC(TTaskInfo& aTask, HBufC*& aDes) const;
    51 	IMPORT_C void UnpackL(const TTaskInfo& aTask, const TDesC& aDes);
    52 
    53 private:
    54 
    55 	HBufC* PackLC() const;
    56 	void UnpackL(const TDesC& aDes);
    57 
    58 	void ExternalizeL(RWriteStream&) const;
    59 	void InternalizeL(RReadStream&);
    60 
    61 	TPtrC Convert(const TDesC8& aDes) const;
    62 	TPtrC8 Convert(const TDesC16& aDes) const;
    63 
    64 public:
    65 
    66 	/** Message ID. */
    67 	TMsvId iId;
    68 
    69 	/** Command ID to be passed to CMsvSession::TransferCommandL() when it is
    70 	time to send the messages. */
    71 	TInt iCommandId;
    72 
    73 	/** Intervals at which the scheduler should check the sending operation's
    74 	progress. */
    75 	TTimeIntervalMicroSeconds32 iPollProgress;
    76 
    77 	/** Server MTM specific binary data to be passed to 
    78 	CMsvSession::TransferCommandL() when it is time to send the messages. */
    79 	TBuf8<KMaxParameterLength> iParameter;
    80 
    81 	};
    82 
    83 #endif