Back to index

lightning-sunbird  0.9+nobinonly
nsUrlClassifierDBService.h
Go to the documentation of this file.
00001 //* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-/
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 Url Classifier code
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Google Inc.
00019  * Portions created by the Initial Developer are Copyright (C) 2006
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Tony Chang <tony@ponderer.org> (original author)
00024  *   Brett Wilson <brettw@gmail.com>
00025  *
00026  * Alternatively, the contents of this file may be used under the terms of
00027  * either the GNU General Public License Version 2 or later (the "GPL"), or
00028  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00029  * in which case the provisions of the GPL or the LGPL are applicable instead
00030  * of those above. If you wish to allow use of your version of this file only
00031  * under the terms of either the GPL or the LGPL, and not to allow others to
00032  * use your version of this file under the terms of the MPL, indicate your
00033  * decision by deleting the provisions above and replace them with the notice
00034  * and other provisions required by the GPL or the LGPL. If you do not delete
00035  * the provisions above, a recipient may use your version of this file under
00036  * the terms of any one of the MPL, the GPL or the LGPL.
00037  *
00038  * ***** END LICENSE BLOCK ***** */
00039 
00040 #ifndef nsUrlClassifierDBService_h_
00041 #define nsUrlClassifierDBService_h_
00042 
00043 #include <nsISupportsUtils.h>
00044 
00045 #include "nsID.h"
00046 #include "nsIObserver.h"
00047 #include "nsIUrlClassifierDBService.h"
00048 
00049 class nsUrlClassifierDBServiceWorker;
00050 
00051 // This is a proxy class that just creates a background thread and delagates
00052 // calls to the background thread.
00053 class nsUrlClassifierDBService : public nsIUrlClassifierDBService,
00054                                  public nsIObserver
00055 {
00056 public:
00057   // This is thread safe. It throws an exception if the thread is busy.
00058   nsUrlClassifierDBService();
00059 
00060   nsresult Init();
00061 
00062   static nsUrlClassifierDBService* GetInstance();
00063 
00064 #ifdef MOZILLA_1_8_BRANCH
00065   NS_DEFINE_STATIC_IID_ACCESSOR(NS_URLCLASSIFIERDBSERVICE_CID)
00066 #else
00067   NS_DECLARE_STATIC_IID_ACCESSOR(NS_URLCLASSIFIERDBSERVICE_CID)
00068 #endif
00069 
00070   NS_DECL_ISUPPORTS
00071   NS_DECL_NSIURLCLASSIFIERDBSERVICE
00072   NS_DECL_NSIOBSERVER
00073 
00074 private:
00075   // No subclassing
00076   ~nsUrlClassifierDBService();
00077 
00078   // Disallow copy constructor
00079   nsUrlClassifierDBService(nsUrlClassifierDBService&);
00080 
00081   // Make sure the event queue is intialized before we use it.
00082   nsresult EnsureThreadStarted();
00083   
00084   // Close db connection and join the background thread if it exists. 
00085   nsresult Shutdown();
00086   
00087   nsCOMPtr<nsUrlClassifierDBServiceWorker> mWorker;
00088 };
00089 
00090 #endif // nsUrlClassifierDBService_h_