SpillOutputStream.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/segment/SpillOutputStream.h#10 $
// 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_SpillOutputStream_Included
#define Fennel_SpillOutputStream_Included

#include "fennel/common/ByteOutputStream.h"
#include "fennel/segment/SegPageLock.h"

FENNEL_BEGIN_NAMESPACE

class LogicalTxn;

class FENNEL_SEGMENT_EXPORT SpillOutputStream
    : public ByteOutputStream
{
    SharedSegmentFactory pSegmentFactory;

    SharedCacheAccessor pCacheAccessor;

    SharedSegOutputStream pSegOutputStream;

    uint cbBuffer;

    SegmentAccessor scratchAccessor;

    SegPageLock scratchPageLock;

    std::string spillFileName;

    // implement the ByteOutputStream interface
    virtual void flushBuffer(uint cbRequested);
    virtual void closeImpl();

    void spill();
    void updatePage();

    explicit SpillOutputStream(
        SharedSegmentFactory,
        SharedCacheAccessor,
        std::string);

public:
    static SharedSpillOutputStream newSpillOutputStream(
        SharedSegmentFactory pSegmentFactory,
        SharedCacheAccessor pCacheAccessor,
        std::string spillFileName);

    virtual ~SpillOutputStream();

    SharedByteInputStream getInputStream(
        SeekPosition seekPosition = SEEK_STREAM_BEGIN);

    SharedSegment getSegment();

    SharedSegOutputStream getSegOutputStream();

    // override ByteOutputStream
    virtual void setWriteLatency(WriteLatency writeLatency);
};

FENNEL_END_NAMESPACE

#endif

// End SpillOutputStream.h

---