store/source/storcach.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: storcach.hxx,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _STORE_STORCACH_HXX
  32 #define _STORE_STORCACH_HXX "$Revision: 1.6.8.2 $"
  33
  34 #include "sal/types.h"
  35 #include "rtl/ref.hxx"
  36
  37 #include "store/types.h"
  38 #include "storbase.hxx"
  39
  40 namespace store
  41 {
  42
  43 /*========================================================================
  44  *
  45  * PageCache interface.
  46  *
  47  *======================================================================*/
  48
  49 class PageCache : public rtl::IReference
  50 {
  51 public:
  52     /** load.
  53      */
  54     storeError lookupPageAt (
  55         PageHolder & rxPage,
  56         sal_uInt32   nOffset);
  57
  58     /** insert.
  59      */
  60     storeError insertPageAt (
  61         PageHolder const & rxPage,
  62         sal_uInt32         nOffset);
  63
  64     /** update, or insert.
  65      */
  66     storeError updatePageAt (
  67         PageHolder const & rxPage,
  68         sal_uInt32         nOffset);
  69
  70     /** remove (invalidate).
  71      */
  72     storeError removePageAt (
  73         sal_uInt32 nOffset);
  74
  75 private:
  76     /** Implementation (abstract).
  77      */
  78     virtual storeError lookupPageAt_Impl (
  79         PageHolder & rxPage,
  80         sal_uInt32   nOffset) = 0;
  81
  82     virtual storeError insertPageAt_Impl (
  83         PageHolder const & rxPage,
  84         sal_uInt32         nOffset) = 0;
  85
  86     virtual storeError updatePageAt_Impl (
  87         PageHolder const & rxPage,
  88         sal_uInt32         nOffset) = 0;
  89
  90     virtual storeError removePageAt_Impl (
  91         sal_uInt32 nOffset) = 0;
  92 };
  93
  94 /*========================================================================
  95  *
  96  * PageCache factory.
  97  *
  98  *======================================================================*/
  99
 100 storeError
 101 PageCache_createInstance (
 102     rtl::Reference< store::PageCache > & rxCache,
 103     sal_uInt16                           nPageSize
 104 );
 105
 106 /*========================================================================
 107  *
 108  * The End.
 109  *
 110  *======================================================================*/
 111
 112 } // namespace store
 113
 114 #endif /* !_STORE_STORCACH_HXX */
 115