Back to index

lightning-sunbird  0.9+nobinonly
nsAboutCacheEntry.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 2001
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Darin Fisher <darin@netscape.com> (original author)
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either the GNU General Public License Version 2 or later (the "GPL"), or
00027  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #ifndef nsAboutCacheEntry_h__
00040 #define nsAboutCacheEntry_h__
00041 
00042 #include "nsIAboutModule.h"
00043 #include "nsIChannel.h"
00044 #include "nsICacheListener.h"
00045 #include "nsICacheSession.h"
00046 #include "nsICacheEntryDescriptor.h"
00047 #include "nsIStreamListener.h"
00048 #include "nsIOutputStream.h"
00049 #include "nsIInputStreamChannel.h"
00050 #include "nsIURI.h"
00051 #include "nsCOMPtr.h"
00052 #include "nsString.h"
00053 
00054 class nsICacheEntryDescriptor;
00055 
00056 class nsAboutCacheEntry : public nsIAboutModule
00057                         , public nsIChannel
00058                         , public nsICacheListener
00059                         , public nsICacheMetaDataVisitor
00060 {
00061 public:
00062     NS_DECL_ISUPPORTS
00063     NS_DECL_NSIABOUTMODULE
00064     NS_DECL_NSIREQUEST
00065     NS_DECL_NSICHANNEL
00066     NS_DECL_NSICACHELISTENER
00067     NS_DECL_NSICACHEMETADATAVISITOR
00068 
00069     nsAboutCacheEntry()
00070         : mBuffer(nsnull)
00071     {}
00072 
00073     virtual ~nsAboutCacheEntry() {}
00074 
00075 private:
00076     nsresult WriteCacheEntryDescription(nsIOutputStream *, nsICacheEntryDescriptor *);
00077     nsresult WriteCacheEntryUnavailable(nsIOutputStream *, nsresult);
00078     nsresult ParseURI(nsCString &, PRBool &, nsCString &);
00079 
00080 private:
00081     nsCOMPtr<nsIURI>                mURI;
00082     nsCOMPtr<nsIInputStreamChannel> mStreamChannel;
00083     nsCOMPtr<nsIStreamListener>     mListener;
00084     nsCOMPtr<nsISupports>           mListenerContext;
00085     nsCOMPtr<nsICacheSession>       mCacheSession;
00086     nsCString *                     mBuffer;
00087 };
00088 
00089 #define NS_ABOUT_CACHE_ENTRY_MODULE_CID              \
00090 { /* 7fa5237d-b0eb-438f-9e50-ca0166e63788 */         \
00091     0x7fa5237d,                                      \
00092     0xb0eb,                                          \
00093     0x438f,                                          \
00094     {0x9e, 0x50, 0xca, 0x01, 0x66, 0xe6, 0x37, 0x88} \
00095 }
00096 
00097 #endif // nsAboutCacheEntry_h__