FlatFileBuffer.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/flatfile/FlatFileBuffer.h#2 $
// Fennel is a library of data storage and processing components.
// Copyright (C) 2005-2009 The Eigenbase Project
// Copyright (C) 2009-2009 SQLstream, Inc.
// Copyright (C) 2004-2009 LucidEra, Inc.
// Portions Copyright (C) 2004-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_FlatFileBuffer_Included
#define Fennel_FlatFileBuffer_Included

#include "fennel/common/ClosableObject.h"
#include "fennel/common/TraceSource.h"

FENNEL_BEGIN_NAMESPACE

class FlatFileBuffer;
typedef boost::shared_ptr<FlatFileBuffer> SharedFlatFileBuffer;

class FENNEL_FLATFILE_EXPORT FlatFileBuffer
    : public ClosableObject, public TraceSource
{
    std::string path;
    FILE *pFile;
    FileSize filePosition;

    char *pBuffer;
    uint bufferSize, contentSize;
    char *pCurrent;

    // implement ClosableObject
    void closeImpl();

public:
    FlatFileBuffer(const std::string &path);
    virtual ~FlatFileBuffer();

    void open();

    void setStorage(char *pBuffer, uint size);

    uint read();

    char *getReadPtr();

    char *getEndPtr();

    int getSize();

    bool isFull();

    bool isComplete();

    bool isDone();

    void setReadPtr(char *ptr);
};

FENNEL_END_NAMESPACE

#endif

// End FlatFileBuffer.h

---