OLD | NEW |
1 // Copyright 2014 The Chromium Authors. All rights reserved. | 1 // Copyright 2014 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef MEDIA_BASE_CDM_PROMISE_H_ | 5 #ifndef MEDIA_BASE_CDM_PROMISE_H_ |
6 #define MEDIA_BASE_CDM_PROMISE_H_ | 6 #define MEDIA_BASE_CDM_PROMISE_H_ |
7 | 7 |
8 #include <string> | 8 #include <string> |
9 | 9 |
10 #include "base/basictypes.h" | 10 #include "base/basictypes.h" |
11 #include "base/callback.h" | 11 #include "base/callback.h" |
12 #include "media/base/media_export.h" | 12 #include "media/base/media_export.h" |
13 #include "media/base/media_keys.h" | 13 #include "media/base/media_keys.h" |
14 | 14 |
15 namespace media { | 15 namespace media { |
16 | 16 |
17 // Interface for promises being resolved/rejected in response to various | 17 // Interface for promises being resolved/rejected in response to various |
18 // session actions. These may be called synchronously or asynchronously. | 18 // session actions. These may be called synchronously or asynchronously. |
19 // The promise must be resolved or rejected exactly once. It is expected that | 19 // The promise must be resolved or rejected exactly once. It is expected that |
20 // the caller free the promise once it is resolved/rejected. | 20 // the caller free the promise once it is resolved/rejected. |
21 // | 21 // |
22 // This is only the base class, as parameter to resolve() varies. | 22 // This is only the base class, as parameter to resolve() varies. |
23 class MEDIA_EXPORT CdmPromise { | 23 class MEDIA_EXPORT CdmPromise { |
24 public: | 24 public: |
| 25 // A superset of media::MediaKeys::Exception for UMA reporting. |
| 26 enum ResultCodeForUMA { |
| 27 SUCCESS, |
| 28 NOT_SUPPORTED_ERROR, |
| 29 INVALID_STATE_ERROR, |
| 30 INVALID_ACCESS_ERROR, |
| 31 QUOTA_EXCEEDED_ERROR, |
| 32 UNKNOWN_ERROR, |
| 33 CLIENT_ERROR, |
| 34 OUTPUT_ERROR, |
| 35 NUM_RESULT_CODES |
| 36 }; |
| 37 |
25 typedef base::Callback<void(MediaKeys::Exception exception_code, | 38 typedef base::Callback<void(MediaKeys::Exception exception_code, |
26 uint32 system_code, | 39 uint32 system_code, |
27 const std::string& error_message)> | 40 const std::string& error_message)> |
28 PromiseRejectedCB; | 41 PromiseRejectedCB; |
29 | 42 |
30 virtual ~CdmPromise(); | 43 virtual ~CdmPromise(); |
31 | 44 |
32 // Used to indicate that the operation failed. |exception_code| must be | 45 // Used to indicate that the operation failed. |exception_code| must be |
33 // specified. |system_code| is a Key System-specific value for the error | 46 // specified. |system_code| is a Key System-specific value for the error |
34 // that occurred, or 0 if there is no associated status code or such status | 47 // that occurred, or 0 if there is no associated status code or such status |
35 // codes are not supported by the Key System. |error_message| is optional. | 48 // codes are not supported by the Key System. |error_message| is optional. |
36 virtual void reject(MediaKeys::Exception exception_code, | 49 virtual void reject(MediaKeys::Exception exception_code, |
37 uint32 system_code, | 50 uint32 system_code, |
38 const std::string& error_message); | 51 const std::string& error_message); |
39 | 52 |
40 protected: | 53 protected: |
41 CdmPromise(); | 54 CdmPromise(); |
42 CdmPromise(PromiseRejectedCB reject_cb); | 55 CdmPromise(PromiseRejectedCB reject_cb); |
43 | 56 |
| 57 // If constructed with a |uma_name| (which must be the name of a |
| 58 // CdmPromiseResult UMA), CdmPromise will report the promise result (success |
| 59 // or rejection code). |
| 60 CdmPromise(PromiseRejectedCB reject_cb, const std::string& uma_name); |
| 61 |
44 PromiseRejectedCB reject_cb_; | 62 PromiseRejectedCB reject_cb_; |
45 | 63 |
46 // Keep track of whether the promise hasn't been resolved or rejected yet. | 64 // Keep track of whether the promise hasn't been resolved or rejected yet. |
47 bool is_pending_; | 65 bool is_pending_; |
48 | 66 |
| 67 // UMA to report result to. |
| 68 std::string uma_name_; |
| 69 |
49 DISALLOW_COPY_AND_ASSIGN(CdmPromise); | 70 DISALLOW_COPY_AND_ASSIGN(CdmPromise); |
50 }; | 71 }; |
51 | 72 |
52 template <typename T> | 73 template <typename T> |
53 class MEDIA_EXPORT CdmPromiseTemplate : public CdmPromise { | 74 class MEDIA_EXPORT CdmPromiseTemplate : public CdmPromise { |
54 public: | 75 public: |
55 CdmPromiseTemplate(base::Callback<void(const T&)> resolve_cb, | 76 CdmPromiseTemplate(base::Callback<void(const T&)> resolve_cb, |
56 PromiseRejectedCB rejected_cb); | 77 PromiseRejectedCB rejected_cb); |
| 78 CdmPromiseTemplate(base::Callback<void(const T&)> resolve_cb, |
| 79 PromiseRejectedCB rejected_cb, |
| 80 const std::string& uma_name); |
57 virtual ~CdmPromiseTemplate(); | 81 virtual ~CdmPromiseTemplate(); |
58 virtual void resolve(const T& result); | 82 virtual void resolve(const T& result); |
59 | 83 |
60 private: | 84 private: |
61 base::Callback<void(const T&)> resolve_cb_; | 85 base::Callback<void(const T&)> resolve_cb_; |
62 | 86 |
63 DISALLOW_COPY_AND_ASSIGN(CdmPromiseTemplate); | 87 DISALLOW_COPY_AND_ASSIGN(CdmPromiseTemplate); |
64 }; | 88 }; |
65 | 89 |
66 // Specialization for no parameter to resolve(). | 90 // Specialization for no parameter to resolve(). |
67 template <> | 91 template <> |
68 class MEDIA_EXPORT CdmPromiseTemplate<void> : public CdmPromise { | 92 class MEDIA_EXPORT CdmPromiseTemplate<void> : public CdmPromise { |
69 public: | 93 public: |
70 CdmPromiseTemplate(base::Callback<void(void)> resolve_cb, | 94 CdmPromiseTemplate(base::Callback<void(void)> resolve_cb, |
71 PromiseRejectedCB rejected_cb); | 95 PromiseRejectedCB rejected_cb); |
| 96 CdmPromiseTemplate(base::Callback<void(void)> resolve_cb, |
| 97 PromiseRejectedCB rejected_cb, |
| 98 const std::string& uma_name); |
72 virtual ~CdmPromiseTemplate(); | 99 virtual ~CdmPromiseTemplate(); |
73 virtual void resolve(); | 100 virtual void resolve(); |
74 | 101 |
75 protected: | 102 protected: |
76 // Allow subclasses to completely override the implementation. | 103 // Allow subclasses to completely override the implementation. |
77 CdmPromiseTemplate(); | 104 CdmPromiseTemplate(); |
78 | 105 |
79 private: | 106 private: |
80 base::Callback<void(void)> resolve_cb_; | 107 base::Callback<void(void)> resolve_cb_; |
81 | 108 |
82 DISALLOW_COPY_AND_ASSIGN(CdmPromiseTemplate); | 109 DISALLOW_COPY_AND_ASSIGN(CdmPromiseTemplate); |
83 }; | 110 }; |
84 | 111 |
85 } // namespace media | 112 } // namespace media |
86 | 113 |
87 #endif // MEDIA_BASE_CDM_PROMISE_H_ | 114 #endif // MEDIA_BASE_CDM_PROMISE_H_ |
OLD | NEW |