os/mm/mmlibs/mmfw/src/Plugin/StdSourceAndSink/MmffilePriv.h
changeset 0 bde4ae8d615e
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/mm/mmlibs/mmfw/src/Plugin/StdSourceAndSink/MmffilePriv.h	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,186 @@
     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 "Eclipse Public License v1.0"
     1.8 +// which accompanies this distribution, and is available
     1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.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 +//
    1.18 +
    1.19 +
    1.20 +#ifndef __MMFFILEPRIV_H_
    1.21 +#define __MMFFILEPRIV_H_
    1.22 +
    1.23 +#include <f32file.h>
    1.24 +
    1.25 +#include <mmf/server/mmfclip.h>
    1.26 +#include <mmf/server/mmfdatabuffer.h>
    1.27 +
    1.28 +
    1.29 +/**
    1.30 + *  @publishedAll
    1.31 + *  @released
    1.32 + *
    1.33 + *  Represents a copy of a KUidMmfTransferBuffer used for reading/writting to the file server
    1.34 + */
    1.35 +
    1.36 +class CTransferBufferCopy : public CBase
    1.37 +	{
    1.38 +public:
    1.39 +	static CTransferBufferCopy* NewL(TInt aMaxLength);
    1.40 +
    1.41 +	virtual ~CTransferBufferCopy()
    1.42 +		{delete iBuffer;}
    1.43 +
    1.44 +
    1.45 +	TDes8& Des() {return iBufferDes;}
    1.46 +
    1.47 +	TInt MaxLength() {return iBufferDes.MaxLength();}
    1.48 +
    1.49 +	void ReUse(TInt aMaxLength) {iBufferDes.Set(iBuffer,0, Min(aMaxLength, iMaxLength));}
    1.50 +
    1.51 +	TBool InUse() {return iInUse;}
    1.52 +
    1.53 +	void SetInUse(TBool aInUse) {iInUse=aInUse;}
    1.54 +
    1.55 +private:
    1.56 +	CTransferBufferCopy(TInt aMaxLength) : CBase(), iMaxLength(aMaxLength), iBufferDes(0,0,0), iInUse(EFalse){}
    1.57 +
    1.58 +	void ConstructL();
    1.59 +
    1.60 +private:
    1.61 +	TUint8*	iBuffer;
    1.62 +	
    1.63 +	//Holds the original MaxLength when class constructed. 
    1.64 +	//May be larger than MaxLength of iBufferDes
    1.65 +	TInt	iMaxLength;
    1.66 +
    1.67 +	TPtr8	iBufferDes;
    1.68 +
    1.69 +	TBool	iInUse;
    1.70 +	};
    1.71 +
    1.72 +
    1.73 +
    1.74 +
    1.75 +/**
    1.76 + * @internalComponent
    1.77 + *
    1.78 + * A request is created when an external object requests or supplies data.  Calls to the File Server are
    1.79 + * made asynchronously and a CReadWriteRequest created to notify the caller on completion.
    1.80 + *
    1.81 + * CReadWriteRequest is an abstract class.  Concrete instances are of CReadRequest & CWriteRequest.
    1.82 + * Concrete instances need to know whether to call MDataSink::BufferFilledL() or MDataSource::BufferEmptiedL()
    1.83 + */
    1.84 +class CReadWriteRequest : public CActive
    1.85 +	{
    1.86 +public:
    1.87 +	CReadWriteRequest(TAny* aSinkOrSource, CMMFBuffer* aBuffer, MAsyncEventHandler* aEventHandler)
    1.88 +	: CActive(EPriorityStandard),
    1.89 +	iSinkOrSource(aSinkOrSource), 
    1.90 +	iBuffer(aBuffer),
    1.91 +	iEventHandler(aEventHandler)
    1.92 +		{
    1.93 +		CActiveScheduler::Add( this );
    1.94 +		}
    1.95 +
    1.96 +	CReadWriteRequest(TAny* aSinkOrSource, CMMFBuffer* aBuffer, CTransferBufferCopy* aOptionalDataBuffer, MAsyncEventHandler* aEventHandler)
    1.97 +	: CActive(EPriorityStandard),
    1.98 +	iSinkOrSource(aSinkOrSource), 
    1.99 +	iBuffer(aBuffer),
   1.100 +	iTransferBufferCopy(aOptionalDataBuffer),
   1.101 +	iEventHandler(aEventHandler)
   1.102 +		{
   1.103 +		CActiveScheduler::Add( this );
   1.104 +		iTransferBufferCopy->SetInUse(ETrue);
   1.105 +		}
   1.106 +		
   1.107 +	CReadWriteRequest(CReadWriteRequest& aRequest)
   1.108 +	: CActive(EPriorityStandard),
   1.109 +	iSinkOrSource(aRequest.iSinkOrSource),
   1.110 +	iBuffer(aRequest.iBuffer),
   1.111 +	iTransferBufferCopy(aRequest.iTransferBufferCopy),
   1.112 +	iEventHandler(aRequest.iEventHandler)
   1.113 +		{
   1.114 +		CActiveScheduler::Add( this );
   1.115 +		iTransferBufferCopy->SetInUse(ETrue);
   1.116 +		}
   1.117 +
   1.118 +		
   1.119 +	TBool Completed() ;
   1.120 +	TDes8& BufferDes() ;
   1.121 +	const TDesC8& BufferDesC() ;
   1.122 +
   1.123 +	~CReadWriteRequest() ;
   1.124 +
   1.125 +
   1.126 +	// CActive functions.
   1.127 +	// 
   1.128 +	void SetActive() ;
   1.129 +	void DoCancel() ;
   1.130 +	virtual void RunL() = 0 ;
   1.131 +	virtual TInt RunError( TInt aError ) ;
   1.132 +	
   1.133 +
   1.134 +protected :
   1.135 +	TAny* iSinkOrSource;
   1.136 +	CMMFBuffer* iBuffer;
   1.137 +	CTransferBufferCopy* iTransferBufferCopy;
   1.138 +
   1.139 +	MAsyncEventHandler* iEventHandler;
   1.140 +	TBool iCompleted ;
   1.141 +	TDes8* iBufferDes ;
   1.142 +	TInt iError ;
   1.143 +	TBool iUseTransferBuffer ;
   1.144 +	void SetTransferBuffer (TBool aTBuffer) ;
   1.145 +	TBool CanUseTransferBuffer () ;
   1.146 +	} ;
   1.147 +
   1.148 +/**
   1.149 + * @internalComponent
   1.150 + */
   1.151 +class CReadRequest : public CReadWriteRequest
   1.152 +	{
   1.153 +public :
   1.154 +	CReadRequest(TAny* aSinkOrSource, CMMFBuffer* aBuffer, TUint aPosition, TUint aFileSize, MAsyncEventHandler* aEventHandler)
   1.155 +	: CReadWriteRequest(aSinkOrSource, aBuffer, aEventHandler),
   1.156 +	iPosition(aPosition), iFileSize(aFileSize)
   1.157 +	{ } 
   1.158 +
   1.159 +	CReadRequest(TAny* aSinkOrSource, CMMFBuffer* aBuffer, CTransferBufferCopy* aOptionalDataBuffer, TUint aPosition, TUint aFileSize, MAsyncEventHandler* aEventHandler)
   1.160 +	: CReadWriteRequest(aSinkOrSource, aBuffer, aOptionalDataBuffer, aEventHandler),
   1.161 +	iPosition(aPosition), iFileSize(aFileSize)
   1.162 +	{ } 
   1.163 +
   1.164 +	void RunL();
   1.165 +private:
   1.166 +	TUint iPosition;
   1.167 +	TUint iFileSize;
   1.168 +	};
   1.169 +
   1.170 +/**
   1.171 + * @internalComponent
   1.172 + */
   1.173 +class CWriteRequest : public CReadWriteRequest
   1.174 +	{
   1.175 +public :
   1.176 +	CWriteRequest(TAny* aSinkOrSource, CMMFBuffer* aBuffer, MAsyncEventHandler* aEventHandler)
   1.177 +	: CReadWriteRequest(aSinkOrSource, aBuffer, aEventHandler)
   1.178 +	{ }
   1.179 +
   1.180 +	CWriteRequest(TAny* aSinkOrSource, CMMFBuffer* aBuffer, CTransferBufferCopy* aOptionalDataBuffer, MAsyncEventHandler* aEventHandler)
   1.181 +	: CReadWriteRequest(aSinkOrSource, aBuffer, aOptionalDataBuffer, aEventHandler)
   1.182 +	{ }
   1.183 +
   1.184 +	void RunL();
   1.185 +	};
   1.186 +
   1.187 +
   1.188 +#endif
   1.189 +