/* ==================================================================== * The Vovida Software License, Version 1.0  *  * Copyright (c) 2000 Vovida Networks, Inc.  All rights reserved. *  * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: *  * 1. Redistributions of source code must retain the above copyright *    notice, this list of conditions and the following disclaimer. *  * 2. Redistributions in binary form must reproduce the above copyright *    notice, this list of conditions and the following disclaimer in *    the documentation and/or other materials provided with the *    distribution. *  * 3. The names "VOCAL", "Vovida Open Communication Application Library", *    and "Vovida Open Communication Application Library (VOCAL)" must *    not be used to endorse or promote products derived from this *    software without prior written permission. For written *    permission, please contact vocal@vovida.org. * * 4. Products derived from this software may not be called "VOCAL", nor *    may "VOCAL" appear in their name, without prior written *    permission of Vovida Networks, Inc. *  * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND * NON-INFRINGEMENT ARE DISCLAIMED.  IN NO EVENT SHALL VOVIDA * NETWORKS, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT DAMAGES * IN EXCESS OF $1,000, NOR FOR ANY INDIRECT, INCIDENTAL, SPECIAL, * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH * DAMAGE. *  * ==================================================================== *  * This software consists of voluntary contributions made by Vovida * Networks, Inc. and many individuals on behalf of Vovida Networks, * Inc.  For more information on Vovida Networks, Inc., please see * <http://www.vovida.org/>. * */ #ifndef CACHESTORAGE_HXX#define CACHESTORAGE_HXX/** * CacheStorage.hxx -- 13/03/03 * * Provides a wrapper around a simple nested hash map that functions as our  * Cache system. * * _Should_ also be thread safe */#include "Record.hxx"#include "DBTypes.h"#include "Mutex.hxx"/* * These typedefs define the nested hashmap we use for  * the cache. They make the rest of the code easier to work with */typedef map<KeyType, Record*> inner_cache;typedef map<RecordType, inner_cache* > outer_cache;typedef inner_cache::iterator inner_cache_itr;typedef outer_cache::iterator outer_cache_itr;typedef inner_cache::value_type key_record_pair;typedef outer_cache::value_type rtype_map_pair;class CacheStorage { public:  CacheStorage();  ~CacheStorage();  /*   * Cache access functions, fairly obvious   */  Record* get(RecordType rtype, KeyType key);  void insert(Record* rec)     { insert(rec->getRecordType(), rec->getKey(), rec); };  void insert(RecordType rtype, KeyType key, Record* rec);  /*  void replace(Record* rec);    { replace(rec->getRecordType(), rec->getKey(), rec); };  void replace(RecordType rtype, KeyType key, Record* rec);  */  void remove(RecordType rtype, KeyType key);  /*    * This function empties the cache and deletes all the objects,    * myCache will still point to a valid, empty, cache.   */  void empty(void);  /*   * This function purges old records from the cache, this is done in    * this class to maintain the abstraction and so that the cache can    * be locked. This function is normally called from the CacheManager   */  void purge() { purge(0); }   void purge(int validity);  /*    * This returns the number of records in the cache   */  int size();  /*    * Display cache for debugging    */  void display(void);private:  inner_cache* getInnerCache(RecordType rtype, bool createIfMissing);  outer_cache* myCache;  Vocal::Threads::Mutex* myMutex; // Used to lock the cache};#endif // CACHESTORAGE_HXX