gecko-dev/security/manager/ssl/nsIProtectedAuthThread.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

49 lines
1.4 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/. */
#include "nsISupports.idl"
#include "nsIObserver.idl"
#include "nsIPKCS11Slot.idl"
/**
* Used to communicate with the thread for logging on to a token with
* CKF_PROTECTED_AUTHENTICATION_PATH set.
*/
[scriptable, uuid(4bb27cb7-8984-4cee-8ce7-9b014c3d091b)]
interface nsIProtectedAuthThread : nsISupports
{
/**
* login - run the thread
* A user interface implementing this interface needs to
* call this method as soon as the message to the user is
* displayed. This will trigger login operation. No user
* cancellation is possible during login operation.
*
* When the login is done, the observe method of @observer will
* be called on the UI thread with a topic of "login-finished"
* and null data and subject.
*/
[must_use]
void login(in nsIObserver observer);
/**
* The PKCS11 slot
*/
[must_use]
readonly attribute nsIPKCS11Slot slot;
/**
* Gets token to be logged in name.
*/
[must_use]
AString getTokenName();
};
%{ C++
// {45334489-3D30-47c6-920B-0A55A313AEBF}
#define NS_PROTECTEDAUTHTHREAD_CID \
{ 0x45334489, 0x3d30, 0x47c6, { 0x92, 0x0b, 0x0a, 0x55, 0xa3, 0x13, 0xae, 0xbf } }
#define NS_PROTECTEDAUTHTHREAD_CONTRACTID "@mozilla.org/security/protectedauththread;1"
%}