ExternalSortSubStream.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/sorter/ExternalSortSubStream.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_ExternalSubStream_Included
#define Fennel_ExternalSubStream_Included

FENNEL_BEGIN_NAMESPACE

class ExternalSortFetchArray;

enum ExternalSortRC
{
    EXTSORT_SUCCESS,

    EXTSORT_ENDOFDATA,

    EXTSORT_OVERFLOW,
};

class FENNEL_SORTER_EXPORT ExternalSortSubStream
{
public:
    virtual ~ExternalSortSubStream()
    {
    }

    virtual ExternalSortFetchArray &bindFetchArray() = 0;

    virtual ExternalSortRC fetch(uint nTuplesRequested) = 0;
};

struct ExternalSortFetchArray
{
    PBuffer *ppTupleBuffers;

    uint nTuples;

    explicit ExternalSortFetchArray()
    {
        ppTupleBuffers = NULL;
        nTuples = 0;
    }
};

const uint EXTSORT_FETCH_ARRAY_SIZE = 100;

FENNEL_END_NAMESPACE

#endif

// End ExternalSortSubStream.h

---