gecko/xpcom/base/nsIUUIDGenerator.idl

73 lines
2.9 KiB
Plaintext
Raw Normal View History

/* -*- Mode: C++; tab-width: 50; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* mozilla.org
* Portions created by the Initial Developer are Copyright (C) 2005
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Vladimir Vukicevic <vladimir@pobox.com> (original author)
*
* Alternatively, the contents of this file may be used under the terms of
* either of the GNU General Public License Version 2 or later (the "GPL"),
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#include "nsISupports.idl"
[ptr] native nsNonConstIDPtr(nsID);
/**
* nsIUUIDGenerator is implemented by a service that can generate
* universally unique identifiers, ideally using any platform-native
* method for generating UUIDs.
*/
[scriptable, uuid(138ad1b2-c694-41cc-b201-333ce936d8b8)]
interface nsIUUIDGenerator : nsISupports
{
/**
* Obtains a new UUID using appropriate platform-specific methods to
* obtain a nsID that can be considered to be globally unique.
*
* @returns an nsID filled in with a new UUID.
*
* @throws NS_ERROR_FAILURE if a UUID cannot be generated (e.g. if
* an underlying source of randomness is not available)
*/
nsIDPtr generateUUID();
/**
* Obtain a new UUID like the generateUUID method, but place it in
* the provided nsID pointer instead of allocating a new nsID.
*
* @param id an existing nsID pointer where the UUID will be stored.
*
* @throws NS_ERROR_FAILURE if a UUID cannot be generated (e.g. if
* an underlying source of randomness is not available)
*/
[noscript] void generateUUIDInPlace(in nsNonConstIDPtr id);
};