SegBufferReader.h

Go to the documentation of this file.
00001 /*
00002 // $Id: //open/dev/fennel/exec/SegBufferReader.h#2 $
00003 // Fennel is a library of data storage and processing components.
00004 // Copyright (C) 2005-2009 The Eigenbase Project
00005 // Copyright (C) 2005-2009 SQLstream, Inc.
00006 // Copyright (C) 2005-2009 LucidEra, Inc.
00007 // Portions Copyright (C) 2004-2009 John V. Sichi
00008 //
00009 // This program is free software; you can redistribute it and/or modify it
00010 // under the terms of the GNU General Public License as published by the Free
00011 // Software Foundation; either version 2 of the License, or (at your option)
00012 // any later version approved by The Eigenbase Project.
00013 //
00014 // This program is distributed in the hope that it will be useful,
00015 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00016 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00017 // GNU General Public License for more details.
00018 //
00019 // You should have received a copy of the GNU General Public License
00020 // along with this program; if not, write to the Free Software
00021 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00022 */
00023 
00024 #ifndef Fennel_SegBufferReader_Included
00025 #define Fennel_SegBufferReader_Included
00026 
00027 #include "fennel/common/ClosableObject.h"
00028 #include "fennel/segment/SegStream.h"
00029 #include "fennel/segment/SegmentAccessor.h"
00030 #include "fennel/exec/ExecStreamDefs.h"
00031 
00032 FENNEL_BEGIN_NAMESPACE
00033 
00041 class FENNEL_EXEC_EXPORT SegBufferReader
00042     : public ClosableObject
00043 {
00044     SharedExecStreamBufAccessor pOutAccessor;
00045     SegmentAccessor bufferSegmentAccessor;
00046     SharedSegInputStream pByteInputStream;
00047     PageId firstPageId;
00048     SegStreamPosition restartPos;
00049     uint cbLastRead;
00050 
00051 public:
00060     static SharedSegBufferReader newSegBufferReader(
00061         SharedExecStreamBufAccessor &pOutAccessor,
00062         SegmentAccessor const &bufferSegmentAccessor,
00063         PageId firstPageId);
00064 
00073     explicit SegBufferReader(
00074         SharedExecStreamBufAccessor &pOutAccessorInit,
00075         SegmentAccessor const &bufferSegmentAccessorInit,
00076         PageId firstPageIdInit);
00077 
00084     void open(bool destroy);
00085 
00093     ExecStreamResult read();
00094 
00095     // implement ClosableObject
00096     virtual void closeImpl();
00097 };
00098 
00099 FENNEL_END_NAMESPACE
00100 
00101 #endif
00102 
00103 // End SegBufferReader.h

Generated on Mon Jun 22 04:00:18 2009 for Fennel by  doxygen 1.5.1