gecko-dev/security/manager/ssl/nsIKeygenThread.idl
Cykesiopka 02bee25903 Bug 1366584 - Add initial [must_use] properties to PSM IDL files. r=keeler
The [must_use] property on XPIDL methods and attributes is useful for making
sure errors are properly handled.

As a first step, this patch adds the property to PSM methods and attributes that
are already correctly checked everywhere.

MozReview-Commit-ID: KyGxwUK3x0X

--HG--
extra : rebase_source : 45bd3f8d305fe221cc1bba73a520f11829dc5a42
2017-05-25 21:56:04 +08:00

51 lines
1.7 KiB
Plaintext

/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
// make sure to include all the required file headers
#include "nsISupports.idl"
interface nsIObserver;
/**
* nsIKeygenThread
* This is used to communicate with the thread generating a key pair,
* to be used by the dialog displaying status information.
*/
[scriptable, uuid(8712a243-5539-447c-9f47-8653f40c3a09)]
interface nsIKeygenThread : nsISupports
{
/**
* startKeyGeneration - run the thread
* A user interface using this interface needs to
* call this method as soon as the status information
* is displaying. This will trigger key generation.
* To allow the closure of the status information,
* the thread needs a handle to an observer.
*
* observer will be called on the UI thread.
* When the key generation is done, the observe method will
* be called with a topic of "keygen-finished" and null data
* and subject.
*/
[must_use]
void startKeyGeneration(in nsIObserver observer);
/**
* userCanceled - notify the thread
* If the user canceled, the thread is no longer allowed to
* close the dialog. However, if the thread already closed
* it, we are not allowed to close it.
*/
[must_use]
void userCanceled(out boolean threadAlreadyClosedDialog);
};
%{ C++
// {195763b8-1dd2-11b2-a843-eb44e44aaa37}
#define NS_KEYGENTHREAD_CID \
{ 0x195763b8, 0x1dd2, 0x11b2, { 0xa8, 0x43, 0xeb, 0x44, 0xe4, 0x4a, 0xaa, 0x37 } }
#define NS_KEYGENTHREAD_CONTRACTID "@mozilla.org/security/keygenthread;1"
%}