netwerk/protocol/about/src/nsAboutCacheEntry.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 2001
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Darin Fisher <darin@netscape.com> (original author)
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #ifndef nsAboutCacheEntry_h__
  40 #define nsAboutCacheEntry_h__
  41
  42 #include "nsIAboutModule.h"
  43 #include "nsIChannel.h"
  44 #include "nsICacheListener.h"
  45 #include "nsICacheSession.h"
  46 #include "nsICacheEntryDescriptor.h"
  47 #include "nsIStreamListener.h"
  48 #include "nsIOutputStream.h"
  49 #include "nsIInputStreamChannel.h"
  50 #include "nsIURI.h"
  51 #include "nsCOMPtr.h"
  52 #include "nsString.h"
  53
  54 class nsICacheEntryDescriptor;
  55
  56 class nsAboutCacheEntry : public nsIAboutModule
  57                         , public nsICacheMetaDataVisitor
  58 {
  59 public:
  60     NS_DECL_ISUPPORTS
  61     NS_DECL_NSIABOUTMODULE
  62     NS_DECL_NSICACHEMETADATAVISITOR
  63
  64     nsAboutCacheEntry()
  65         : mBuffer(nsnull)
  66     {}
  67
  68     virtual ~nsAboutCacheEntry() {}
  69
  70 private:
  71     nsresult GetContentStream(nsIURI *, nsIInputStream **);
  72     nsresult OpenCacheEntry(nsIURI *, nsICacheEntryDescriptor **);
  73     nsresult WriteCacheEntryDescription(nsIOutputStream *, nsICacheEntryDescriptor *);
  74     nsresult WriteCacheEntryUnavailable(nsIOutputStream *);
  75     nsresult ParseURI(nsIURI *, nsCString &, PRBool &, nsCString &);
  76
  77 private:
  78     nsCString *mBuffer;
  79 };
  80
  81 #define NS_ABOUT_CACHE_ENTRY_MODULE_CID              \
  82 { /* 7fa5237d-b0eb-438f-9e50-ca0166e63788 */         \
  83     0x7fa5237d,                                      \
  84     0xb0eb,                                          \
  85     0x438f,                                          \
  86     {0x9e, 0x50, 0xca, 0x01, 0x66, 0xe6, 0x37, 0x88} \
  87 }
  88
  89 #endif // nsAboutCacheEntry_h__