bridges/source/remote/urp/urp_cache.h

   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: urp_cache.h,v $
  10  * $Revision: 1.5 $
  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
  32 namespace bridges_urp
  33 {
  34     template < class t , class tequals >
  35     class Cache
  36     {
  37     public:
  38         inline Cache ( sal_uInt16 nMaxEntries );
  39         inline ~Cache();
  40
  41         // puts the value t into the cache. Returns then entry,
  42         // that is used for this value.
  43         inline sal_uInt16 put( const t & );
  44
  45         // lookup, if there is an entry for this value
  46         // returns 0xffff, when value cannot be found in the list
  47         inline sal_uInt16 seek( const t & );
  48
  49         // resizes the cache, conserving overlapping values
  50         inline void resize( sal_uInt16 nNewMaxEntries );
  51
  52         // empties the cache
  53         inline void clear();
  54     private:
  55         t *m_pCache;
  56         ::std::list< sal_uInt16 > m_lstLeastRecentlyUsed;
  57         sal_uInt16 m_nMaxEntries;
  58         sal_uInt16 m_nEntries;
  59     };
  60 }