epoc32/include/obexservermtm.h
branchSymbian2
changeset 2 2fe1408b6811
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/obexservermtm.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -0,0 +1,132 @@
     1.4 +// Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.5 +// All rights reserved.
     1.6 +// This component and the accompanying materials are made available
     1.7 +// 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
     1.8 +// which accompanies this distribution, and is available
     1.9 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.10 +//
    1.11 +// Initial Contributors:
    1.12 +// Nokia Corporation - initial contribution.
    1.13 +//
    1.14 +// Contributors:
    1.15 +//
    1.16 +// Description:
    1.17 +// $Workfile: obexServerMtm.h $
    1.18 +// $Author: Stevep $
    1.19 +// $Revision: 9 $
    1.20 +// $Date: 12/12/01 15:56 $
    1.21 +// 
    1.22 +//
    1.23 +
    1.24 +
    1.25 +#if !defined(__OBEXSERVERMTM_H__)
    1.26 +#define __OBEXSERVERMTM_H__
    1.27 +
    1.28 +
    1.29 +#if !defined(__MTSR_H__)
    1.30 +#include <mtsr.h>
    1.31 +#endif
    1.32 +
    1.33 +#include <obexclientmtm.h>
    1.34 +
    1.35 +class CObexServerSendOperation;
    1.36 +class CObexSrvMtm : public CBaseServerMtm
    1.37 +/**
    1.38 +@internalTechnology
    1.39 +@released
    1.40 +*/
    1.41 +	{
    1.42 +public:
    1.43 +	enum TObexMtmOperations
    1.44 +		{
    1.45 +		EObexMtmUiNullOp,
    1.46 +		EObexMtmUiObexSend
    1.47 +		};
    1.48 +
    1.49 +public:
    1.50 +	
    1.51 +	/**
    1.52 +	 * Destructor: Cancels active object (this)s
    1.53 +	 */
    1.54 +	
    1.55 +	IMPORT_C ~CObexSrvMtm();
    1.56 +
    1.57 +	IMPORT_C virtual void CopyToLocalL(const CMsvEntrySelection& aSelection,TMsvId aDestination, TRequestStatus& aStatus);
    1.58 +	IMPORT_C virtual void MoveToLocalL(const CMsvEntrySelection& aSelection,TMsvId aDestination, TRequestStatus& aStatus);
    1.59 +	
    1.60 +	
    1.61 +	/**
    1.62 +	 * Copies a selection of entries from a local location to a remote location
    1.63 +	 * N.B. Leaves as not supported
    1.64 +	 *
    1.65 +	 * @param aSelection The collection of message index entries for which the copy is required
    1.66 +	 * @param aServiceId The entry ID of the service by which the entries should be transferred
    1.67 +	 * @param aStatus Indicates operation completion
    1.68 +	 */
    1.69 +	
    1.70 +	IMPORT_C virtual void CopyFromLocalL(const CMsvEntrySelection& aSelection,TMsvId aDestination, TRequestStatus& aStatus);
    1.71 +	IMPORT_C virtual void MoveFromLocalL(const CMsvEntrySelection& aSelection,TMsvId aDestination, TRequestStatus& aStatus);
    1.72 +	IMPORT_C virtual void CopyWithinServiceL(const CMsvEntrySelection& aSelection,TMsvId aDestination, TRequestStatus& aStatus);
    1.73 +	IMPORT_C virtual void MoveWithinServiceL(const CMsvEntrySelection& aSelection,TMsvId aDestination, TRequestStatus& aStatus);
    1.74 +	IMPORT_C void DeleteL(const CMsvEntrySelection& aSelection, TRequestStatus& aStatus);
    1.75 +	IMPORT_C virtual void DeleteAllL(const CMsvEntrySelection& aSelection, TRequestStatus& aStatus);
    1.76 +	IMPORT_C virtual void CreateL(TMsvEntry aNewEntry, TRequestStatus& aStatus);
    1.77 +	IMPORT_C virtual void ChangeL(TMsvEntry aNewEntry, TRequestStatus& aStatus);
    1.78 +	//
    1.79 +	//STP now defined in the base classes
    1.80 +	//IMPORT_C virtual void StartCommandL(CMsvEntrySelection& aSelection, TInt aCommand, const TDesC8& aParameter, TRequestStatus& aStatus);
    1.81 +	//
    1.82 +	IMPORT_C virtual TBool CommandExpected();
    1.83 +	
    1.84 +	/**
    1.85 +	 * Obtains progress from the send operation and copies it into the iProgress member
    1.86 +	 * 
    1.87 +	 * @return a TBufPckg<TImSmtpProgress maintained by the instantiated CMsgImOutboxSend object
    1.88 +	 */
    1.89 +
    1.90 +	IMPORT_C virtual const TDesC8& Progress();
    1.91 +	
    1.92 +	/**
    1.93 +	 * Sets message entry to be sent to aEntry
    1.94 +	 *
    1.95 +	 * @param aEntry message server entry (service)
    1.96 +	 */
    1.97 +	
    1.98 +	IMPORT_C void SetInitialEntry(CMsvServerEntry* aEntry);
    1.99 +
   1.100 +protected:
   1.101 +
   1.102 +	/**
   1.103 +	 * Constructor
   1.104 +	 *
   1.105 +	 * @param aRegisterMtmDll	registration data for MTM dll
   1.106 +	 * @param aEntry			Message Server entry to operate upon
   1.107 +	 */
   1.108 +
   1.109 +	IMPORT_C CObexSrvMtm(CRegisteredMtmDll& aRegisteredMtmDll, CMsvServerEntry* aEntry);
   1.110 +	
   1.111 +	/**
   1.112 +	 * Second phase constructor adds Obex server Mtm (this) to the active scheduler
   1.113 +	 */
   1.114 +
   1.115 +	IMPORT_C void ConstructL();
   1.116 +	
   1.117 +	/**
   1.118 +	 * Cancels the obex send operation
   1.119 +	 */
   1.120 +	
   1.121 +	IMPORT_C virtual void DoCancel();
   1.122 +	IMPORT_C virtual void DoRunL();
   1.123 +	IMPORT_C virtual void DoComplete(TInt aError);
   1.124 +
   1.125 +protected:
   1.126 +	CMsvServerEntry*				iEntry;	//< entry to send
   1.127 +	CObexServerSendOperation*		iSendOperation;	//< used by the derived classes to hold the send operation of the appropriate derived type
   1.128 +	TRequestStatus*					iReportStatus;
   1.129 +
   1.130 +
   1.131 +private:
   1.132 +	TPckgBuf<TObexMtmProgress>	iProgress;	//<progress buffer holds a local copy of iSendOperation's progress
   1.133 +	};
   1.134 +
   1.135 +#endif  // __OBEXSERVERMTM_H__