Back to index

lightning-sunbird  0.9+nobinonly
nsIUrlClassifierDBService.idl
Go to the documentation of this file.
00001 /* ***** BEGIN LICENSE BLOCK *****
00002  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00003  *
00004  * The contents of this file are subject to the Mozilla Public License Version
00005  * 1.1 (the "License"); you may not use this file except in compliance with
00006  * the License. You may obtain a copy of the License at
00007  * http://www.mozilla.org/MPL/
00008  *
00009  * Software distributed under the License is distributed on an "AS IS" basis,
00010  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00011  * for the specific language governing rights and limitations under the
00012  * License.
00013  *
00014  * The Original Code is Url Classifier code
00015  *
00016  * The Initial Developer of the Original Code is
00017  * Google Inc.
00018  * Portions created by the Initial Developer are Copyright (C) 2006
00019  * the Initial Developer. All Rights Reserved.
00020  *
00021  * Contributor(s):
00022  *   Tony Chang <tony@ponderer.org> (original author)
00023  *   Brett Wilson <brettw@gmail.com>
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 #include "nsISupports.idl"
00040 
00041 // Interface for JS function callbacks
00042 [scriptable, function, uuid(4ca27b6b-a674-4b3d-ab30-d21e2da2dffb)]
00043 interface nsIUrlClassifierCallback : nsISupports {
00044   void handleEvent(in ACString value);
00045 };
00046 
00052 [scriptable, uuid(211d5360-4af6-4a1d-99c1-926d35861eaf)]
00053 interface nsIUrlClassifierDBService : nsISupports
00054 {
00061   void exists(in ACString tableName, in ACString key,
00062               in nsIUrlClassifierCallback c);
00063 
00070   void checkTables(in ACString tableNames, in nsIUrlClassifierCallback c);
00071 
00077   void updateTables(in ACString updateString, in nsIUrlClassifierCallback c);
00078 
00080   // Incremental update methods.  These are named to match similar methods
00081   // in, e.g., nsICryptoHash.
00082 
00086   void update(in ACString updateChunk);
00087 
00088   // It would be nice to have an updateFromStream method to round out the
00089   // interface, but it's tricky because of XPCOM proxies.
00090 
00095   void finish(in nsIUrlClassifierCallback c);
00096 
00101   void cancelStream();
00102 };
00103 
00108 [scriptable, uuid(5d405325-2ba1-4040-b69b-8bda8353d3d3)]
00109 interface nsIUrlClassifierDBServiceWorker : nsIUrlClassifierDBService
00110 {
00111   // Provide a way to forcibly close the db connection.
00112   void closeDb();
00113 };