netwerk/cache/src/nsCache.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
   2  *
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is nsCache.h, released
  17  * March 18, 2001.
  18  *
  19  * The Initial Developer of the Original Code is
  20  * Netscape Communications Corporation.
  21  * Portions created by the Initial Developer are Copyright (C) 2001
  22  * the Initial Developer. All Rights Reserved.
  23  *
  24  * Contributor(s):
  25  *   Gordon Sheridan  <gordon@netscape.com>
  26  *   Patrick C. Beard <beard@netscape.com>
  27  *   Darin Fisher     <darin@netscape.com>
  28  *
  29  * Alternatively, the contents of this file may be used under the terms of
  30  * either the GNU General Public License Version 2 or later (the "GPL"), or
  31  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  32  * in which case the provisions of the GPL or the LGPL are applicable instead
  33  * of those above. If you wish to allow use of your version of this file only
  34  * under the terms of either the GPL or the LGPL, and not to allow others to
  35  * use your version of this file under the terms of the MPL, indicate your
  36  * decision by deleting the provisions above and replace them with the notice
  37  * and other provisions required by the GPL or the LGPL. If you do not delete
  38  * the provisions above, a recipient may use your version of this file under
  39  * the terms of any one of the MPL, the GPL or the LGPL.
  40  *
  41  * ***** END LICENSE BLOCK ***** */
  42
  43 /**
  44  * Cache Service Utility Functions
  45  */
  46
  47 #ifndef _nsCache_h_
  48 #define _nsCache_h_
  49
  50 #include "nsISupports.h"
  51 #include "nsIFile.h"
  52 #include "nsAString.h"
  53 #include "prtime.h"
  54 #include "nsError.h"
  55 #include "prlog.h"
  56
  57 // PR_LOG args = "format string", arg, arg, ...
  58 #if defined(PR_LOGGING)
  59 extern PRLogModuleInfo * gCacheLog;
  60 void   CacheLogInit();
  61 void   CacheLogPrintPath(PRLogModuleLevel level,
  62                          char *           format,
  63                          nsIFile *        item);
  64 #define CACHE_LOG_INIT()        CacheLogInit()
  65 #define CACHE_LOG_ALWAYS(args)  PR_LOG(gCacheLog, PR_LOG_ALWAYS, args)
  66 #define CACHE_LOG_ERROR(args)   PR_LOG(gCacheLog, PR_LOG_ERROR, args)
  67 #define CACHE_LOG_WARNING(args) PR_LOG(gCacheLog, PR_LOG_WARNING, args)
  68 #define CACHE_LOG_DEBUG(args)   PR_LOG(gCacheLog, PR_LOG_DEBUG, args)
  69 #define CACHE_LOG_PATH(level, format, item) \
  70                                 CacheLogPrintPath(level, format, item)
  71 #else
  72 #define CACHE_LOG_INIT()        {}
  73 #define CACHE_LOG_ALWAYS(args)  {}
  74 #define CACHE_LOG_ERROR(args)   {}
  75 #define CACHE_LOG_WARNING(args) {}
  76 #define CACHE_LOG_DEBUG(args)   {}
  77 #define CACHE_LOG_PATH(level, format, item)  {}
  78 #endif
  79
  80
  81 extern PRUint32  SecondsFromPRTime(PRTime prTime);
  82 extern PRTime    PRTimeFromSeconds(PRUint32 seconds);
  83
  84
  85 extern nsresult  ClientIDFromCacheKey(const nsACString&  key, char ** result);
  86 extern nsresult  ClientKeyFromCacheKey(const nsCString& key, nsACString &result);
  87
  88
  89 #endif // _nsCache_h