FileDevice.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/device/FileDevice.h#12 $
// Fennel is a library of data storage and processing components.
// Copyright (C) 2005-2009 The Eigenbase Project
// Copyright (C) 2005-2009 SQLstream, Inc.
// Copyright (C) 2005-2009 LucidEra, Inc.
// Portions Copyright (C) 1999-2009 John V. Sichi
//
// This program is free software; you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the Free
// Software Foundation; either version 2 of the License, or (at your option)
// any later version approved by The Eigenbase Project.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifndef Fennel_FileDevice_Included
#define Fennel_FileDevice_Included

#include "fennel/device/DeviceMode.h"
#include "fennel/synch/SynchObj.h"

FENNEL_BEGIN_NAMESPACE

class DeviceIOListener;
class RandomAccessRequest;

class FENNEL_DEVICE_EXPORT FileDevice
{
protected:
    // REVIEW:  should this be synchronized here or at a higher level?
    FileSize cbFile;

    int handle;

    DeviceMode mode;

    std::string filename;

    StrictMutex mutex;

public:
    FileDevice(std::string filename,DeviceMode mode,FileSize initialSize);
    virtual ~FileDevice();

    void transfer(RandomAccessRequest const &request);

    void flush();

    void close();

    bool isOpen() const
    {
        return handle == -1 ? 0 : 1;
    }

    FileSize getSizeInBytes()
    {
        return cbFile;
    }

    void setSizeInBytes(FileSize cbNew);
};

FENNEL_END_NAMESPACE

#endif

// End FileDevice.h

---