sbIDatabaseEngine.idl

Go to the documentation of this file.

/*
 //
// BEGIN SONGBIRD GPL
// 
// This file is part of the Songbird web player.
//
// Copyright(c) 2005-2008 POTI, Inc.
// http://songbirdnest.com
// 
// This file may be licensed under the terms of of the
// GNU General Public License Version 2 (the "GPL").
// 
// Software distributed under the License is distributed 
// on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either 
// express or implied. See the GPL for the specific language 
// governing rights and limitations.
//
// You should have received a copy of the GPL along with this 
// program. If not, go to http://www.gnu.org/licenses/gpl.html
// or write to the Free Software Foundation, Inc., 
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
// 
// END SONGBIRD GPL
//
 */

#include "nsISupports.idl"

interface nsIFile;


[ptr] native CDatabaseQueryPtr(CDatabaseQuery);
[ref] native stlCStringRef(std::string);

[scriptable, uuid(2fbdee94-afa1-4fd3-abec-c87e5c340681)]
interface sbIDatabaseEngine : nsISupports
{
  [noscript] PRInt32 SubmitQuery(in CDatabaseQueryPtr aDBQuery);

  void closeDatabase(in AString aDatabaseGUID);

  void dumpDatabase(in AString aDatabaseGUID, in nsIFile aOutFile);
  
  void dumpMemoryStatistics();

  long getCurrentMemoryUsage(in long flag);

  long getHighWaterMemoryUsage(in long flag);

  const long DATABASE_MEMORYUSED = 0;
  const long DATABASE_PAGECACHEUSED = 1;
  const long DATABASE_PAGECACHEOVERFLOW = 2;

  void releaseMemory();
  
  attribute boolean localeCollationEnabled;
  
  readonly attribute AString localeCollationID;
   
};