BESCache.h

Go to the documentation of this file.
00001 // BESCache.h
00002 
00003 // This file is part of bes, A C++ back-end server implementation framework
00004 // for the OPeNDAP Data Access Protocol.
00005 
00006 // Copyright (c) 2004,2005 University Corporation for Atmospheric Research
00007 // Author: Patrick West <pwest@ucar.edu> and Jose Garcia <jgarcia@ucar.edu>
00008 //
00009 // This library is free software; you can redistribute it and/or
00010 // modify it under the terms of the GNU Lesser General Public
00011 // License as published by the Free Software Foundation; either
00012 // version 2.1 of the License, or (at your option) any later version.
00013 // 
00014 // This library is distributed in the hope that it will be useful,
00015 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00016 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00017 // Lesser General Public License for more details.
00018 // 
00019 // You should have received a copy of the GNU Lesser General Public
00020 // License along with this library; if not, write to the Free Software
00021 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00022 //
00023 // You can contact University Corporation for Atmospheric Research at
00024 // 3080 Center Green Drive, Boulder, CO 80301
00025  
00026 // (c) COPYRIGHT University Corporation for Atmospheric Research 2004-2005
00027 // Please read the full copyright statement in the file COPYRIGHT_UCAR.
00028 //
00029 // Authors:
00030 //      pwest       Patrick West <pwest@ucar.edu>
00031 //      jgarcia     Jose Garcia <jgarcia@ucar.edu>
00032 
00033 #ifndef BESCache_h_
00034 #define BESCache_h_ 1
00035 
00036 #include <string>
00037 
00038 using std::string ;
00039 
00040 #include "BESObj.h"
00041 
00042 class BESKeys ;
00043 
00054 class BESCache : public BESObj
00055 {
00056 private:
00057     string                      _cache_dir ;
00058     string                      _prefix ;
00059     unsigned int                _cache_size ;
00060     int                         _lock_fd ;
00061 
00062     void                        check_ctor_params();
00063                                 BESCache() {}
00064 public:
00065                                 BESCache( const string &cache_dir,
00066                                           const string &prefix,
00067                                           unsigned int size ) ;
00068                                 BESCache( BESKeys &keys,
00069                                           const string &cache_dir_key,
00070                                           const string &prefix_key,
00071                                           const string &size_key ) ;
00072     virtual                     ~BESCache() {}
00073 
00074     virtual bool                lock( unsigned int retry_ms,
00075                                       unsigned int num_tries ) ;
00076     virtual bool                unlock() ;
00077 
00078     virtual bool                is_cached( const string &src, string &target ) ;
00079     virtual void                purge( ) ;
00080 
00081     string                      cache_dir( ) { return _cache_dir ; }
00082     string                      prefix( ) { return _prefix ; }
00083     unsigned int                cache_size( ) { return _cache_size ; }
00084 
00085     virtual void                dump( ostream &strm ) const ;
00086 };
00087 
00088 #endif // BESCache_h_
00089 

Generated on Wed Aug 29 03:20:58 2007 for OPeNDAP Back End Server (BES) by  doxygen 1.5.2