CacheAccessor.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/cache/CacheAccessor.h#14 $
// 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_CacheAccessor_Included
#define Fennel_CacheAccessor_Included

#include <boost/utility.hpp>

FENNEL_BEGIN_NAMESPACE

class CachePage;
class MappedPageListener;

class FENNEL_CACHE_EXPORT CacheAccessor : public boost::noncopyable
{
public:
    virtual ~CacheAccessor();

    virtual CachePage *lockPage(
        BlockId blockId,
        LockMode lockMode,
        bool readIfUnmapped = true,
        MappedPageListener *pMappedPageListener = NULL,
        TxnId txnId = IMPLICIT_TXN_ID) = 0;

    virtual void unlockPage(
        CachePage &page,
        LockMode lockMode,
        TxnId txnId = IMPLICIT_TXN_ID) = 0;

    virtual void discardPage(BlockId blockId) = 0;

    virtual bool prefetchPage(
        BlockId blockId,
        MappedPageListener *pMappedPageListener = NULL) = 0;

    virtual void prefetchBatch(
        BlockId blockId,uint nPages,
        MappedPageListener *pMappedPageListener = NULL) = 0;

    virtual void flushPage(CachePage &page,bool async) = 0;

    virtual void nicePage(CachePage &page) = 0;

    virtual uint getMaxLockedPages() = 0;

    virtual void setMaxLockedPages(uint nPages) = 0;

    virtual SharedCache getCache() = 0;

    virtual void setTxnId(TxnId txnId) = 0;

    virtual TxnId getTxnId() const = 0;

    virtual void getPrefetchParams(
        uint &prefetchPagesMax,
        uint &prefetchThrottleRate) = 0;
};

FENNEL_END_NAMESPACE

#endif

// End CacheAccessor.h

---