store/source/storcach.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef _STORE_STORCACH_HXX
  21 #define _STORE_STORCACH_HXX
  22
  23 #include "sal/types.h"
  24 #include "rtl/ref.hxx"
  25
  26 #include "store/types.h"
  27 #include "storbase.hxx"
  28
  29 namespace store
  30 {
  31
  32 /*========================================================================
  33  *
  34  * PageCache interface.
  35  *
  36  *======================================================================*/
  37
  38 class PageCache : public rtl::IReference
  39 {
  40 public:
  41     /** load.
  42      */
  43     storeError lookupPageAt (
  44         PageHolder & rxPage,
  45         sal_uInt32   nOffset);
  46
  47     /** insert.
  48      */
  49     storeError insertPageAt (
  50         PageHolder const & rxPage,
  51         sal_uInt32         nOffset);
  52
  53     /** update, or insert.
  54      */
  55     storeError updatePageAt (
  56         PageHolder const & rxPage,
  57         sal_uInt32         nOffset);
  58
  59     /** remove (invalidate).
  60      */
  61     storeError removePageAt (
  62         sal_uInt32 nOffset);
  63
  64 protected:
  65     ~PageCache() {}
  66
  67 private:
  68     /** Implementation (abstract).
  69      */
  70     virtual storeError lookupPageAt_Impl (
  71         PageHolder & rxPage,
  72         sal_uInt32   nOffset) = 0;
  73
  74     virtual storeError insertPageAt_Impl (
  75         PageHolder const & rxPage,
  76         sal_uInt32         nOffset) = 0;
  77
  78     virtual storeError updatePageAt_Impl (
  79         PageHolder const & rxPage,
  80         sal_uInt32         nOffset) = 0;
  81
  82     virtual storeError removePageAt_Impl (
  83         sal_uInt32 nOffset) = 0;
  84 };
  85
  86 /*========================================================================
  87  *
  88  * PageCache factory.
  89  *
  90  *======================================================================*/
  91
  92 storeError
  93 PageCache_createInstance (
  94     rtl::Reference< store::PageCache > & rxCache,
  95     sal_uInt16                           nPageSize
  96 );
  97
  98 /*========================================================================
  99  *
 100  * The End.
 101  *
 102  *======================================================================*/
 103
 104 } // namespace store
 105
 106 #endif /* !_STORE_STORCACH_HXX */
 107
 108 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */