store/source/storcach.hxx

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