1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=2 et sw=2 tw=80: */
/* 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/. */
#ifndef mozilla__CryptoTask_h
#define mozilla__CryptoTask_h
#include "mozilla/Attributes.h"
#include "nsThreadUtils.h"
#include "nsNSSShutDown.h"
namespace mozilla {
/**
* Frequently we need to run a task on a background thread without blocking
* the main thread, and then call a callback on the main thread with the
* result. This class provides the framework for that. Subclasses must:
*
* (1) Override CalculateResult for the off-the-main-thread computation.
* NSS functionality may only be accessed within CalculateResult.
* (2) Override ReleaseNSSResources to release references to all NSS
* resources (that do implement nsNSSShutDownObject themselves).
* (3) Override CallCallback() for the on-the-main-thread call of the
* callback.
*
* CalculateResult, ReleaseNSSResources, and CallCallback are called in order,
* except CalculateResult might be skipped if NSS is shut down before it can
* be called; in that case ReleaseNSSResources will be called and then
* CallCallback will be called with an error code.
*
* That sequence of events is what happens if you call Dispatch. If for
* some reason, you decide not to run the task (e.g., due to an error in the
* constructor), you may call Skip, in which case the task is cleaned up and
* not run. In that case, only ReleaseNSSResources is called. (So a
* subclass must be prepared for ReleaseNSSResources to be run without
* CalculateResult having been called first.)
*
* Once a CryptoTask is created, the calling code must call either
* Dispatch or Skip.
*
*/
class CryptoTask : public Runnable,
public nsNSSShutDownObject
{
public:
template <size_t LEN>
nsresult Dispatch(const char (&taskThreadName)[LEN])
{
static_assert(LEN <= 15,
"Thread name must be no more than 15 characters");
return Dispatch(nsDependentCString(taskThreadName, LEN - 1));
}
nsresult Dispatch(const nsACString& taskThreadName);
void Skip()
{
virtualDestroyNSSReference();
}
protected:
CryptoTask()
: mRv(NS_ERROR_NOT_INITIALIZED),
mReleasedNSSResources(false)
{
}
virtual ~CryptoTask();
/**
* Called on a background thread (never the main thread). If CalculateResult
* is called, then its result will be passed to CallCallback on the main
* thread.
*/
virtual nsresult CalculateResult() = 0;
/**
* Called on the main thread during NSS shutdown or just before CallCallback
* has been called. All NSS resources must be released. Usually, this just
* means assigning nullptr to the ScopedNSSType-based memory variables.
*/
virtual void ReleaseNSSResources() = 0;
/**
* Called on the main thread with the result from CalculateResult() or
* with an error code if NSS was shut down before CalculateResult could
* be called.
*/
virtual void CallCallback(nsresult rv) = 0;
private:
NS_IMETHOD Run() override final;
virtual void virtualDestroyNSSReference() override final;
nsresult mRv;
bool mReleasedNSSResources;
nsCOMPtr<nsIThread> mThread;
};
} // namespace mozilla
#endif // mozilla__CryptoTask_h
|
