Songbird / Development / Songbird Add-Ons API Documentation

components/dbengine/public/sbIDatabaseEngine.idl

Go to the documentation of this file.
00001 /*
00002  //
00003 // BEGIN SONGBIRD GPL
00004 // 
00005 // This file is part of the Songbird web player.
00006 //
00007 // Copyright(c) 2005-2008 POTI, Inc.
00008 // http://songbirdnest.com
00009 // 
00010 // This file may be licensed under the terms of of the
00011 // GNU General Public License Version 2 (the "GPL").
00012 // 
00013 // Software distributed under the License is distributed 
00014 // on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either 
00015 // express or implied. See the GPL for the specific language 
00016 // governing rights and limitations.
00017 //
00018 // You should have received a copy of the GPL along with this 
00019 // program. If not, go to http://www.gnu.org/licenses/gpl.html
00020 // or write to the Free Software Foundation, Inc., 
00021 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
00022 // 
00023 // END SONGBIRD GPL
00024 //
00025  */
00026 
00033 #include "nsISupports.idl"
00034 
00035 interface nsIFile;
00036 
00037 
00038 [ptr] native CDatabaseQueryPtr(CDatabaseQuery);
00039 [ref] native stlCStringRef(std::string);
00040 
00049 [scriptable, uuid(2fbdee94-afa1-4fd3-abec-c87e5c340681)]
00050 interface sbIDatabaseEngine : nsISupports
00051 {
00058   [noscript] PRInt32 SubmitQuery(in CDatabaseQueryPtr aDBQuery);
00059 
00067   void closeDatabase(in AString aDatabaseGUID);
00068 
00072   void dumpDatabase(in AString aDatabaseGUID, in nsIFile aOutFile);
00073   
00078   void dumpMemoryStatistics();
00079 
00083   long getCurrentMemoryUsage(in long flag);
00084 
00088   long getHighWaterMemoryUsage(in long flag);
00089 
00099   const long DATABASE_MEMORYUSED = 0;
00100   const long DATABASE_PAGECACHEUSED = 1;
00101   const long DATABASE_PAGECACHEOVERFLOW = 2;
00102 
00109   void releaseMemory();
00110   
00116   attribute boolean localeCollationEnabled;
00117   
00121   readonly attribute AString localeCollationID;
00122    
00123 };

Generated on Tue Mar 10 14:28:54 2009 for Songbird by  doxygen 1.5.2