web/webcache.hh

/* -*- mode: c++; c-basic-offset: 4; -*- */
#ifndef _LIGO_WEBCACHE_H
#define _LIGO_WEBCACHE_H
/*----------------------------------------------------------------------*/
/*                                                                      */
/* Module Name: webcache                                                */
/*                                                                      */
/* Module Description: a cache for web servers                          */
/*                                                                      */
/* Revision History:                                                    */
/* Rel   Date     Programmer    Comments                                */
/* 0.1   4Jan02   D. Sigg       First release                           */
/*                                                                      */
/* Documentation References:                                            */
/*      Man Pages: webcache.html                                        */
/*      References: none                                                */
/*                                                                      */
/* Author Information:                                                  */
/* Name          Telephone       Fax             e-mail                 */
/* Daniel Sigg   (509) 372-8132  (509) 372-8137  sigg_d@ligo.mit.edu    */
/*                                                                      */
/*                                                                      */
/*                      -------------------                             */
/*                                                                      */
/*                             LIGO                                     */
/*                                                                      */
/*        THE LASER INTERFEROMETER GRAVITATIONAL WAVE OBSERVATORY.      */
/*                                                                      */
/*                     (C) The LIGO Project, 1999.                      */
/*                                                                      */
/*                                                                      */
/* Caltech                              MIT                             */
/* LIGO Project MS 51-33                LIGO Project NW-17 161          */
/* Pasadena CA 91125                    Cambridge MA 01239              */
/*                                                                      */
/* LIGO Hanford Observatory             LIGO Livingston Observatory     */
/* P.O. Box 1970 S9-02                  19100 LIGO Lane Rd.             */
/* Richland WA 99352                    Livingston, LA 70754            */
/*                                                                      */
/*----------------------------------------------------------------------*/

#include "gmutex.hh"
#include "Time.hh"
#include <sys/types.h>
#include <string>
#include <map>
#include <vector>
#include <utility>

namespace web {


   class webcache {
   public:
      class cachepage {
      public:
         typedef std::pair <std::string, std::string> header_entry;
         typedef std::vector <header_entry> header_type;
      
         cachepage();
         cachepage (const Time& exp, const char* d, int len,
                   const header_type& header);
         cachepage (const Time& exp, const std::string& s,
                   const header_type& header);
         cachepage (const cachepage& page);
         virtual ~cachepage();
         cachepage& operator= (const cachepage& page);
         void load (const char* d, int len);
         void load (const std::string& s);
         const Time& getTime() const {
            return fTime; }
         void setTime (Time& t) {
            fTime = t; }
         char* get() {
            return fData; }
         const char* get() const {
            return fData; }
         int size() const {
            return fLen; }
         header_type& header() {
            return fHeader; }
         const header_type& header() const {
            return fHeader; }
         void setHeader (const header_type& header) {
            fHeader = header; }
         bool allowCompress() const {
            return fAllowCompress; }
         void setAllowCompress (bool allow = true) {
            fAllowCompress = allow; }
      
      protected:
         Time           fTime;
         char*          fData;
         int            fLen;
         header_type    fHeader;
         bool           fAllowCompress;
      };
   
      struct urlcompare {
         bool operator() (const std::string& s1, const std::string& s2) const;
      };
      typedef std::map<std::string, cachepage, urlcompare> cachelist; 
   
      webcache (int maxsize = 1024*1024, bool autocleanup = false);
      virtual ~webcache();
      bool add (const char* url, const cachepage& page);
      bool lookup (const char* url, cachepage& page);
      void cleanup (const Time& now);
      bool enableAutoCleanup ();
      void setMax (int size);   
      int getMax() const {
         return fMaxSize; }     
      int size() const; 
      bool reduceCache (int size);
   
   protected:
      mutable thread::recursivemutex    fMux;
      int               fMaxSize;
      cachelist         fCache;
      pthread_t         fCleanupID;
   };


}

#endif // _LIGO_WEBCACHE_H

---