1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/persistentdata/persistentstorage/store/pcstore/src/filestreambuf.h	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,81 @@
     1.4 +// Copyright (c) 2006-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 +#if !defined(__FILESTREAMBUF_H__)
    1.20 +#define __FILESTREAMBUF_H__
    1.21 +
    1.22 +#include <stdio.h>
    1.23 +#include <pcstore/streamid.h>
    1.24 +
    1.25 +namespace PCStore
    1.26 +{
    1.27 +class CDirectFileStore;
    1.28 +
    1.29 +/**
    1.30 +@internalComponent
    1.31 + 
    1.32 +A file stream buffer that provides I/O interfaces for streamed data.
    1.33 +
    1.34 +This file stream buffer: 
    1.35 +. is unbuffered: all data passed to it will immediately be written to the corresponding file
    1.36 +  or returned to its caller.
    1.37 +
    1.38 +. provides read or write capability: it opens the file in read or write mode. After it is 
    1.39 +  instantiated, only read or write function can be called, depending on the file open mode. 
    1.40 +  Exception will be thrown upon an unmatching call.
    1.41 +
    1.42 +. is unseekable. It only moves the file pointer to the position represented by the stream id, 
    1.43 +  which is passed to its constructor. In the subsequent read or write operations, the pointer 
    1.44 +  always goes forward.
    1.45 +
    1.46 +For each file store, one object of this class is created in the constructor of CDirectFileStore. 
    1.47 +CDirectFileStore will pass the reference of this object to the stream it creates. In order to 
    1.48 +ensure there is only one stream opened in any moment, streams will call the StreamOpen and 
    1.49 +StreamClose methods respectively in their constructor and destructor to signal their open 
    1.50 +and close.
    1.51 +
    1.52 +@see CDirectFileStore 
    1.53 +@see CStoreWriteStream
    1.54 +@see CStoreReadStream
    1.55 +*/
    1.56 +class CFileStreamBuf
    1.57 +	{
    1.58 +public:
    1.59 +	//Enumerations for the file open mode
    1.60 +	enum TFileMode 
    1.61 +	{
    1.62 +	EReadFile=0,
    1.63 +	EWriteFile=1
    1.64 +	};
    1.65 +
    1.66 +public:
    1.67 +	CFileStreamBuf(const char* aFileName, TFileMode aMode);
    1.68 +	~CFileStreamBuf();
    1.69 +	void StreamOpen(TStreamId aStreamId);
    1.70 +	void StreamClose();
    1.71 +	TStreamId GetNewStreamId();
    1.72 +	void Read(const TUint8* aPtr, TInt32 aLength);
    1.73 +	void Write(const TUint8* aPtr, TInt32 aLength);
    1.74 +
    1.75 +private:
    1.76 +	CFileStreamBuf(const CFileStreamBuf& aBuf); 
    1.77 +	CFileStreamBuf& operator=(const CFileStreamBuf& aBuf); 
    1.78 +
    1.79 +private:
    1.80 +	FILE* iFile;
    1.81 +	TBool iStreamOpened;
    1.82 +	};
    1.83 +}
    1.84 +#endif // !defined(__FILESTREAMBUF_H__)