xpcom/base/nsIUUIDGenerator.idl

   1 /* -*- Mode: C++; tab-width: 50; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * mozilla.org
  19  * Portions created by the Initial Developer are Copyright (C) 2005
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Vladimir Vukicevic <vladimir@pobox.com> (original author)
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "nsISupports.idl"
  40
  41 [ptr] native nsNonConstIDPtr(nsID);
  42
  43 /**
  44  * nsIUUIDGenerator is implemented by a service that can generate
  45  * universally unique identifiers, ideally using any platform-native
  46  * method for generating UUIDs.
  47  */
  48 [scriptable, uuid(138ad1b2-c694-41cc-b201-333ce936d8b8)]
  49 interface nsIUUIDGenerator : nsISupports
  50 {
  51   /**
  52    * Obtains a new UUID using appropriate platform-specific methods to
  53    * obtain a nsID that can be considered to be globally unique.
  54    *
  55    * @returns an nsID filled in with a new UUID.
  56    *
  57    * @throws NS_ERROR_FAILURE if a UUID cannot be generated (e.g. if
  58    * an underlying source of randomness is not available)
  59    */
  60   nsIDPtr generateUUID();
  61
  62   /**
  63    * Obtain a new UUID like the generateUUID method, but place it in
  64    * the provided nsID pointer instead of allocating a new nsID.
  65    *
  66    * @param id an existing nsID pointer where the UUID will be stored.
  67    *
  68    * @throws NS_ERROR_FAILURE if a UUID cannot be generated (e.g. if
  69    * an underlying source of randomness is not available)
  70    */
  71   [noscript] void generateUUIDInPlace(in nsNonConstIDPtr id);
  72 };