---

oscl_file_io.h

Go to the documentation of this file.

// -*- c++ -*-
// = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =

//                     O S C L _ F I L E  _ I O

// = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =

#ifndef OSCL_FILE_IO_H_INCLUDED
#define OSCL_FILE_IO_H_INCLUDED

#ifndef OSCLCONFIG_IO_H_INCLUDED
#include "osclconfig_io.h"
#endif

#ifndef OSCL_BASE_H_INCLUDED
#include "oscl_base.h"
#endif

#ifndef OSCL_MEM_H_INCLUDED
#include "oscl_mem.h"
#endif

class PVLogger;
class OsclFileCache;
class Oscl_FileServer;
class OsclFileHandle;
class OsclNativeFile;
class OsclFileStats;
class OsclNativeFileParams;
class OsclAsyncFile;
#define TOsclFileOffsetInt32 int32

class Oscl_File : public HeapBase
{
    public:

        typedef enum
        {
            SEEKSET,
            SEEKCUR,
            SEEKEND
        } seek_type;

        typedef enum
        {
            MODE_READ =      0x0001,
            MODE_READWRITE = 0x0002,
            MODE_APPEND =    0x0004,
            MODE_BINARY =    0x0008,
            MODE_TEXT =      0x0010,
            MODE_READ_PLUS =  0x0020

        } mode_type;

        OSCL_IMPORT_REF Oscl_File();

        OSCL_IMPORT_REF Oscl_File(uint32 aCacheSize);
        OSCL_IMPORT_REF Oscl_File(uint32 aCacheSize, OsclFileHandle* aFileHandle);

        OSCL_IMPORT_REF ~Oscl_File();

        OSCL_IMPORT_REF void SetPVCacheSize(uint32 aSize);

        OSCL_IMPORT_REF void SetNativeAccessMode(uint32 aMode);

        enum TSymbianAccessMode
        {
            ESymbianAccessMode_Rfile = 0
            , ESymbianAccessMode_RfileBuf = 1
        };

        OSCL_IMPORT_REF void SetNativeBufferSize(int32 aSize);

        OSCL_IMPORT_REF void SetAsyncReadBufferSize(uint32 aSize);

        OSCL_IMPORT_REF int32 SetFileHandle(OsclFileHandle* aHandle);

        OSCL_IMPORT_REF int32 Open(const char *filename, uint32 mode, Oscl_FileServer& fileserv);

        OSCL_IMPORT_REF int32 Open(const oscl_wchar *filename, uint32 mode, Oscl_FileServer& fileserv);

        OSCL_IMPORT_REF uint32 Read(OsclAny *buffer,
                                    uint32 size,
                                    uint32 numelements);

        OSCL_IMPORT_REF uint32 Write(const OsclAny *buffer,
                                     uint32 size,
                                     uint32 numelements);


        OSCL_IMPORT_REF int32 Seek(TOsclFileOffset offset,
                                   seek_type origin);

        OSCL_IMPORT_REF TOsclFileOffset Tell();


        OSCL_IMPORT_REF int32 Close();


        OSCL_IMPORT_REF int32 Flush();


        OSCL_IMPORT_REF int32 EndOfFile();


        OSCL_IMPORT_REF int32 GetError();

        OsclFileHandle* Handle()
        {
            return iOpenFileHandle;
        }

        OSCL_IMPORT_REF TOsclFileOffset Size();

        OSCL_IMPORT_REF void SetLoggingEnable(bool aEnable);

        OSCL_IMPORT_REF void SetSummaryStatsLoggingEnable(bool aEnable);


    private:
        friend class OsclFileCache;
        friend class asyncfilereadwrite_test;
        friend class largeasyncfilereadwrite_test;
        friend class asyncfilereadcancel_test;

        void Construct();
        void OldCacheDefaults();
        void OldCacheSelect(uint32);

        //state info
        bool iIsOpen;

        //For Logging
        PVLogger* iLogger;
        PVLogger* iStatsLogger;
        PVLogger* iNativeLogger;
        PVLogger* iAsyncLogger;
        OsclFileStats* iFileStats;
        void CreateFileStats();

        //External file handle.
        OsclFileHandle* iOpenFileHandle;

        //For PV File Cache
        uint32 iPVCacheSize;
        OsclFileCache* iFileCache;

        int32 OpenFileCacheOrAsyncBuffer(const char *filename
                                         , const oscl_wchar* wfilename
                                         , uint32 mode
                                         , const OsclNativeFileParams& params
                                         , Oscl_FileServer& fileserv) ;

        //For native file I/O.
        OsclNativeFile* iNativeFile;
        int32 iNativeBufferSize;
        uint32 iNativeAccessMode;

        //For async read feature
        uint32 iAsyncReadBufferSize;
        OsclAsyncFile* iAsyncFile;

        // These are wrappers to call the Native OS File IO calls with
        // stats and logging.

        int32  CallNativeOpen(const OsclFileHandle&, uint32 mode
                              , const OsclNativeFileParams& params
                              , Oscl_FileServer& fileserv);
        int32  CallNativeOpen(const oscl_wchar *filename, uint32 mode
                              , const OsclNativeFileParams& params
                              , Oscl_FileServer& fileserv);
        int32  CallNativeOpen(const char *filename, uint32 mode
                              , const OsclNativeFileParams& params
                              , Oscl_FileServer& fileserv);
        uint32 CallNativeRead(OsclAny *buffer, uint32 size, uint32 numelements);
        uint32 CallNativeWrite(const OsclAny *buffer, uint32 size, uint32 numelements);
        int32  CallNativeSeek(TOsclFileOffset offset, Oscl_File::seek_type origin);
        TOsclFileOffset  CallNativeTell();
        int32  CallNativeFlush();
        int32  CallNativeEndOfFile();
        TOsclFileOffset CallNativeSize();
        int32 CallNativeClose();
        uint32 CallNativeMode();
        int32 CallNativeGetError();
        OSCL_IMPORT_REF uint32 GetAsyncFileNumOfRun();
        OSCL_IMPORT_REF uint32 GetAsyncFileNumOfRunError();

};


//Include all public file apis for convenience here.
#include "oscl_file_server.h"
#include "oscl_file_find.h"
#include "oscl_file_dir_utils.h"
#include "oscl_file_handle.h"

#endif // OSCL_FILE_IO_H_INCLUDED

---