UpdateableFileImpl.h

Go to the documentation of this file.

//==============================================================================================
//  FILENAME    :   UpdateableFileImpl.h
//  AUTHOR      :   vovechkin
//  CREATION    :   2004-10-04
//  Copyright (C) MicroStrategy Incorporated 2004
//  All Rights Reserved
//==============================================================================================
#ifndef MFileSystem_UpdateableFileImpl_h
#define MFileSystem_UpdateableFileImpl_h

#include "Base/Base/String.h"

#include "../UpdateableFile.h"
#include "FileImpl.h"

#ifndef WIN32
#include "InprocessFileLocker.h"
#endif // WIN32

namespace MFileSystem
{
    class UpdateableFileImpl:
        virtual public UpdateableFile
    {
    public:

        UpdateableFileImpl(
            const char* ipPath,
            IF_COMMIT_AND_CLOSE_WAS_NOT_CALLED iWhatToDoIfCommitAndCloseWasNotCalled);

        virtual ~UpdateableFileImpl() throw();

    protected:

        virtual const char* GetPath() const;

        virtual bool IsAccessibleViaPath() const;

        virtual Int64 GetSize() const;

        virtual Int64 GetPosition() const;

        virtual void MovePosition(Int64 iOffset);

        virtual void SetPosition(Int64 iOffset);

        virtual Int64 SetPositionToEnd();

    protected:

        virtual void Read(void* ipBuffer, size_t iBufferSize);

        virtual void Read(MDataType::Binary& irBinary, size_t iMaxSize);

        virtual void ReadLittleEndian(unsigned Int32& orValue);

        virtual void ReadLine(MDataType::Binary& irBinary);
        
        virtual const MBase::TotalTimer& GetReadTimer() const;

        virtual const MBase::TotalTimer& GetReadLockTimer() const;

        virtual bool ReadLock(bool iNoWait);
        
        virtual void ReadUnlock() throw();

    protected:

        virtual void Write(const char* ipString, size_t iLength);

        virtual void Write(const void* ipData, size_t iByteLength);

        virtual void WriteLittleEndian(const unsigned Int32& irValue);

        virtual void Flush();

        virtual void Truncate();

        virtual void CommitAndClose();

        virtual const MBase::TotalTimer& GetWriteTimer() const;

        virtual const MBase::TotalTimer& GetWriteLockTimer() const;

        virtual bool WriteLock(bool iNoWait);
        
        virtual void WriteUnlock() throw();

    private:

        const IF_COMMIT_AND_CLOSE_WAS_NOT_CALLED mWhatToDoIfCommitAndCloseWasNotCalled;

        const std::string mPath;

        MFileSystem::FileHandle mFileHandle;

        // flags
        bool mPendingFlush;
        bool mPositionUndefined;
        bool mReadLocked;
        bool mWriteLocked;

        MBase::TotalTimer mReadTimer;
        MBase::TotalTimer mReadLockTimer;

        MBase::TotalTimer mWriteTimer;
        MBase::TotalTimer mWriteLockTimer;

#ifndef WIN32
        InprocessFileLocker::LockPtr mInprocessFileLockerPtr;
#endif // WIN32
    };
}

#endif // MFileSystem_UpdateableFileImpl_h