content/browser/service_worker/service_worker_provider_host.h

   1 // Copyright 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CONTENT_BROWSER_SERVICE_WORKER_SERVICE_WORKER_PROVIDER_HOST_H_
   6 #define CONTENT_BROWSER_SERVICE_WORKER_SERVICE_WORKER_PROVIDER_HOST_H_
   7
   8 #include <set>
   9
  10 #include "base/memory/ref_counted.h"
  11 #include "base/memory/weak_ptr.h"
  12 #include "content/common/content_export.h"
  13 #include "webkit/common/resource_type.h"
  14
  15 namespace IPC {
  16 class Sender;
  17 }
  18
  19 namespace content {
  20
  21 class ServiceWorkerContextCore;
  22 class ServiceWorkerDispatcherHost;
  23 class ServiceWorkerRequestHandler;
  24 class ServiceWorkerVersion;
  25
  26 // This class is the browser-process representation of a serice worker
  27 // provider. There is a provider per document and the lifetime of this
  28 // object is tied to the lifetime of its document in the renderer process.
  29 // This class holds service worker state that is scoped to an individual
  30 // document.
  31 //
  32 // Note this class can also host a running service worker, in which
  33 // case it will observe resource loads made directly by the service worker.
  34 class CONTENT_EXPORT ServiceWorkerProviderHost
  35     : public base::SupportsWeakPtr<ServiceWorkerProviderHost> {
  36  public:
  37   ServiceWorkerProviderHost(int process_id,
  38                             int provider_id,
  39                             base::WeakPtr<ServiceWorkerContextCore> context,
  40                             ServiceWorkerDispatcherHost* dispatcher_host);
  41   ~ServiceWorkerProviderHost();
  42
  43   int process_id() const { return process_id_; }
  44   int provider_id() const { return provider_id_; }
  45   const std::set<int>& script_client_thread_ids() const {
  46     return script_client_thread_ids_;
  47   }
  48
  49   bool IsHostToRunningServiceWorker() {
  50     return running_hosted_version_ != NULL;
  51   }
  52
  53   // The service worker version that corresponds with
  54   // navigator.serviceWorker.active for our document.
  55   ServiceWorkerVersion* active_version() const {
  56     return active_version_.get();
  57   }
  58
  59   // The service worker version that corresponds with
  60   // navigate.serviceWorker.pending for our document.
  61   ServiceWorkerVersion* pending_version() const {
  62     return pending_version_.get();
  63   }
  64
  65   // The running version, if any, that this provider is providing resource
  66   // loads for.
  67   ServiceWorkerVersion* running_hosted_version() const {
  68     return running_hosted_version_.get();
  69   }
  70
  71   void set_document_url(const GURL& url) { document_url_ = url; }
  72   const GURL& document_url() const { return document_url_; }
  73
  74   // Adds and removes script client thread ID, who is listening events
  75   // dispatched from ServiceWorker to the document (and any of its dedicated
  76   // workers) corresponding to this provider.
  77   void AddScriptClient(int thread_id);
  78   void RemoveScriptClient(int thread_id);
  79
  80   // Associate |version| to this provider as its '.active' or '.pending'
  81   // version.
  82   // Giving NULL to this method will unset the corresponding field.
  83   void SetActiveVersion(ServiceWorkerVersion* version);
  84   void SetPendingVersion(ServiceWorkerVersion* version);
  85
  86   // Returns false if the version is not in the expected STARTING in our
  87   // our process state. That would be indicative of a bad IPC message.
  88   bool SetHostedVersionId(int64 versions_id);
  89
  90   // Returns a handler for a request, the handler may return NULL if
  91   // the request doesn't require special handling.
  92   scoped_ptr<ServiceWorkerRequestHandler> CreateRequestHandler(
  93       ResourceType::Type resource_type);
  94
  95  private:
  96   const int process_id_;
  97   const int provider_id_;
  98   GURL document_url_;
  99   std::set<int> script_client_thread_ids_;
 100   scoped_refptr<ServiceWorkerVersion> active_version_;
 101   scoped_refptr<ServiceWorkerVersion> pending_version_;
 102   scoped_refptr<ServiceWorkerVersion> running_hosted_version_;
 103   base::WeakPtr<ServiceWorkerContextCore> context_;
 104   ServiceWorkerDispatcherHost* dispatcher_host_;
 105
 106   DISALLOW_COPY_AND_ASSIGN(ServiceWorkerProviderHost);
 107 };
 108
 109 }  // namespace content
 110
 111 #endif  // CONTENT_BROWSER_SERVICE_WORKER_SERVICE_WORKER_PROVIDER_HOST_H_