Source release v3.5.0

core/include/cdm_engine.h

@@ -14,9 +14,11 @@
 #include "file_store.h"
 #include "initialization_data.h"
 #include "lock.h"
+#include "metrics_collections.h"
 #include "oemcrypto_adapter.h"
 #include "scoped_ptr.h"
 #include "service_certificate.h"
+#include "timer_metric.h"
 #include "wv_cdm_constants.h"
 #include "wv_cdm_types.h"
 
@@ -47,17 +49,6 @@ class CdmEngine {
   // Report whether the service certificate has been set.
   virtual bool HasServiceCertificate();
 
-  // Generate and return a Service Certificate Request message.
-  // This message can be sent to the License Server to get a service
-  // certificate.
-  virtual bool GetServiceCertificateRequest(CdmKeyMessage* request);
-
-  // Parse the message returned by the License Server in response to a
-  // Service Certificate Request message. Return the service certificate
-  // from the parsed response.
-  virtual CdmResponseType ParseServiceCertificateResponse(
-      const std::string& response, std::string* certificate);
-
   // Session related methods
   virtual CdmResponseType OpenSession(
       const CdmKeySystem& key_system, CdmClientPropertySet* property_set,
@@ -103,7 +94,26 @@ class CdmEngine {
       const CdmSessionId& session_id, const CdmKeySetId& key_set_id,
       const InitializationData& init_data, const CdmLicenseType license_type,
       CdmAppParameterMap& app_parameters, CdmKeyRequest* key_request);
-  // Accept license response and extract key info.
+  // This API may
+  // (a) accept license response, extract key info and load keys.
+  // (b) accept a renewal response and update license policy information.
+  // (c) accept a release response and release an offline license or secure
+  //     stop.
+  // (d) accept a service certificate and cache that information for the
+  //     the lifetime of the session.
+  //
+  // |session_id| identifies the session that generated the request and can
+  //              process the response. Should be empty if a release response.
+  // |key_data| is the license, renewal, release response or service
+  //            certificate response.
+  // |key_set_id| should be non-null and specified if license release.
+  //              If offline license or streaming license associated with
+  //              a secure stop, |key_set_id| should be non-null and will
+  //              be filled in on return. Use the |key_set_id| with
+  //              RestoreKeys (to reload offline session) or
+  //              GenerateKeyRequest (to release offline session/secure stop).
+  //              |key_set_id| will be cleared if release or streaming
+  //              (not associated with a secure stop).
   virtual CdmResponseType AddKey(const CdmSessionId& session_id,
                                  const CdmKeyResponse& key_data,
                                  CdmKeySetId* key_set_id);
@@ -167,8 +177,8 @@ class CdmEngine {
   // (origin-specific) file system.
   virtual bool IsProvisioned(CdmSecurityLevel security_level);
 
-  // Remove provisioning-related from the current (origin-specific) file system.
-  // This will force the device to reprovision itself.
+  // Remove device DRM certificate from the current (origin-specific) file
+  // system. This will force the device to reprovision itself.
   virtual CdmResponseType Unprovision(CdmSecurityLevel security_level);
 
   // Delete OEMCrypto usage tables. Used by Unprovision().
@@ -270,6 +280,8 @@ class CdmEngine {
   // dead lock.
   virtual void OnTimerEvent();
 
+  virtual metrics::EngineMetrics* GetMetrics() { return &metrics_; }
+
  private:
   // private methods
   CdmResponseType OpenSession(
@@ -290,6 +302,17 @@ class CdmEngine {
   void CloseExpiredReleaseSessions();
 
   // instance variables
+
+  /*
+   * The metrics group must be the first variable declared to ensure
+   * that it is the last member destroyed so that no child members
+   * try to use a reference to it after it is destroyed. This will
+   * ensure that all data has been properly recorded in the group before
+   * it is published.
+   */
+  metrics::EngineMetrics metrics_;
+  metrics::TimerMetric life_span_;
+
   CdmSessionMap session_map_;
   CdmReleaseKeySetMap release_key_sets_;
   scoped_ptr<CertificateProvisioning> cert_provisioning_;