xpcom/base/nsIUUIDGenerator.idl@6474c204b198 (annotated)
xpcom/base/nsIUUIDGenerator.idl
Wed, 31 Dec 2014 06:09:35 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:09:35 +0100
- changeset 0
- 6474c204b198
- permissions
- -rw-r--r--
Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.
| michael@0 | 1 | /* -*- Mode: C++; tab-width: 50; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ |
| michael@0 | 2 | /* This Source Code Form is subject to the terms of the Mozilla Public |
| michael@0 | 3 | * License, v. 2.0. If a copy of the MPL was not distributed with this |
| michael@0 | 4 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
| michael@0 | 5 | |
| michael@0 | 6 | #include "nsISupports.idl" |
| michael@0 | 7 | |
| michael@0 | 8 | [ptr] native nsNonConstIDPtr(nsID); |
| michael@0 | 9 | |
| michael@0 | 10 | /** |
| michael@0 | 11 | * nsIUUIDGenerator is implemented by a service that can generate |
| michael@0 | 12 | * universally unique identifiers, ideally using any platform-native |
| michael@0 | 13 | * method for generating UUIDs. |
| michael@0 | 14 | */ |
| michael@0 | 15 | [scriptable, uuid(138ad1b2-c694-41cc-b201-333ce936d8b8)] |
| michael@0 | 16 | interface nsIUUIDGenerator : nsISupports |
| michael@0 | 17 | { |
| michael@0 | 18 | /** |
| michael@0 | 19 | * Obtains a new UUID using appropriate platform-specific methods to |
| michael@0 | 20 | * obtain a nsID that can be considered to be globally unique. |
| michael@0 | 21 | * |
| michael@0 | 22 | * @returns an nsID filled in with a new UUID. |
| michael@0 | 23 | * |
| michael@0 | 24 | * @throws NS_ERROR_FAILURE if a UUID cannot be generated (e.g. if |
| michael@0 | 25 | * an underlying source of randomness is not available) |
| michael@0 | 26 | */ |
| michael@0 | 27 | nsIDPtr generateUUID(); |
| michael@0 | 28 | |
| michael@0 | 29 | /** |
| michael@0 | 30 | * Obtain a new UUID like the generateUUID method, but place it in |
| michael@0 | 31 | * the provided nsID pointer instead of allocating a new nsID. |
| michael@0 | 32 | * |
| michael@0 | 33 | * @param id an existing nsID pointer where the UUID will be stored. |
| michael@0 | 34 | * |
| michael@0 | 35 | * @throws NS_ERROR_FAILURE if a UUID cannot be generated (e.g. if |
| michael@0 | 36 | * an underlying source of randomness is not available) |
| michael@0 | 37 | */ |
| michael@0 | 38 | [noscript] void generateUUIDInPlace(in nsNonConstIDPtr id); |
| michael@0 | 39 | }; |
